org.egov.infra.web.struts.actions

Class ReportFormAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

org.egov.infra.web.struts.actions.BaseFormAction

org.egov.infra.web.struts.actions.ReportFormAction

All Implemented Interfaces:

com.opensymphony.xwork2.Action, com.opensymphony.xwork2.interceptor.ParameterNameAware, com.opensymphony.xwork2.interceptor.ValidationAware, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.ModelDriven<Object>, com.opensymphony.xwork2.Preparable, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, Serializable, org.apache.struts2.interceptor.ParameterAware, org.apache.struts2.interceptor.RequestAware, org.apache.struts2.interceptor.SessionAware

public abstract class ReportFormAction
extends BaseFormAction

Infrastructure class that provides generic reporting functionality. Can be extended by action classes for reports screen. Provides action method "report" for report generation. Implementing classes need to implement methods ReportFormAction#getReportTemplateName() and ReportFormAction#criteria()

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	REPORT The result code for report action

Fields inherited from class org.egov.infra.web.struts.actions.BaseFormAction

dropdownData, EDIT, INDEX, NEW, ordering, parameters, persistenceService, relations, request, VIEW

Fields inherited from class com.opensymphony.xwork2.ActionSupport

container, LOG

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
ReportFormAction()

Method Summary

Modifier and Type	Method and Description
protected void	clearCriteriaParams() Clears all criteria parameters
abstract String	criteria() The criteria action method.
ReportRequest.ReportDataSourceType	getDataSourceType()
Object	getModel()
Object	getReportData()
ReportConstants.FileFormat	getReportFormat()
String	getReportId()
protected Object	getReportParam(String paramName) Returns value of the given report parameter
protected abstract String	getReportTemplateName()
String	report() Action method that creates the report
void	setDataSourceType(ReportRequest.ReportDataSourceType dataSourceType)
void	setReportData(Object reportData)
void	setReportFormat(ReportConstants.FileFormat reportFormat)
void	setReportParam(String paramName, Object paramValue) Sets the given report parameter
void	setReportService(ReportService reportService)

Methods inherited from class org.egov.infra.web.struts.actions.BaseFormAction

acceptableParameterName, addDropdownData, addRelatedEntity, addRelatedEntity, getDropdownData, getOrdering, getPersistenceService, getRelationships, getSession, prepare, session, setParameters, setPersistenceService, setRequest, setSession, setupDropdownDataExcluding, setValue, tokenName

Methods inherited from class com.opensymphony.xwork2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, execute, getActionErrors, getActionMessages, getFieldErrors, getFormatted, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, validate

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REPORT

public static final String REPORT

The result code for report action

See Also:

Constant Field Values

Constructor Detail

ReportFormAction

public ReportFormAction()

Method Detail

getModel

public Object getModel()

setReportService

public void setReportService(ReportService reportService)

Parameters:

reportService - the reportService to set

clearCriteriaParams

protected void clearCriteriaParams()

Clears all criteria parameters

setReportParam

public void setReportParam(String paramName,
                           Object paramValue)

Sets the given report parameter

Parameters:

paramName - Name of report parameter

paramValue - Value of report parameter

getReportParam

protected Object getReportParam(String paramName)

Returns value of the given report parameter

Parameters:

paramName - Name of report parameter

setReportFormat

public void setReportFormat(ReportConstants.FileFormat reportFormat)

Parameters:

reportFormat - the reportFormat to set

getReportFormat

public ReportConstants.FileFormat getReportFormat()

Returns:

the reportFormat

setDataSourceType

public void setDataSourceType(ReportRequest.ReportDataSourceType dataSourceType)

Parameters:

dataSourceType - the dataSourceType to set

getDataSourceType

public ReportRequest.ReportDataSourceType getDataSourceType()

Returns:

the dataSourceType

setReportData

public void setReportData(Object reportData)

Parameters:

reportData - the reportData to set

getReportData

public Object getReportData()

Returns:

the reportData

getReportId

public String getReportId()

Returns:

the reportId

report

public String report()

Action method that creates the report

Returns:

report

criteria

public abstract String criteria()

The criteria action method. Should populate the required data (e.g. drop down data and default values for criteria fields) and forward to appropriate jsp.

Returns:

Result of criteria action

getReportTemplateName

protected abstract String getReportTemplateName()

Returns:

the report template name