org.egov.infra.web.struts.actions

Class SearchFormAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

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

org.egov.infra.web.struts.actions.SearchFormAction

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

Direct Known Subclasses:

GenericWorkFlowAction

public abstract class SearchFormAction
extends BaseFormAction

Generic Search Form Action. Can be extended by any action class that intends to provide search functionality. Supports pagination. Extending class must implement the method SearchFormAction#prepareQuery() that prepares the query based on criteria entered by user, and returns an object of SearchQuery

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.displaytag.pagination.PaginatedList	searchResult

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

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

Fields inherited from class com.opensymphony.xwork2.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
SearchFormAction()

Method Summary

Modifier and Type	Method and Description
String	getDir()
int	getPage()
int	getPageSize()
org.displaytag.pagination.PaginatedList	getSearchResult()
String	getSort()
String	getSortDir()
abstract SearchQuery	prepareQuery(String sortField, String sortOrder)
String	search() The Search action method.
void	setDir(String sortDir)
void	setPage(int pageNum)
void	setPageSize(int pageSize)
void	setSort(String sortField)
void	setSortDir(String sortDir)
void	setTableId(String tableId) Sets the display tag table id.

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, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opensymphony.xwork2.ModelDriven

getModel

Field Detail

searchResult

protected org.displaytag.pagination.PaginatedList searchResult

Constructor Detail

SearchFormAction

public SearchFormAction()

Method Detail

setTableId

public void setTableId(String tableId)

Sets the display tag table id. This is used to create the param encoder. The param encoder is used to fetch data from encoded request parameters. The request parameters related to display tag are encoded in case the attribute "export" is set to true in the "display:table" tag.

Parameters:

tableId - The id of the display tag table (in "display:table" tag)

setPage

public void setPage(int pageNum)

Parameters:

pageNum - the page number to set

getPage

public int getPage()

Returns:

the current page number

setPageSize

public void setPageSize(int pageSize)

Parameters:

pageSize - the pageSize to set

getPageSize

public int getPageSize()

Returns:

the pageSize

getSort

public String getSort()

Returns:

Field on which data is to be sorted

setSort

public void setSort(String sortField)

Parameters:

sortField - Field on which data is to be sorted

getSortDir

public String getSortDir()

Returns:

Sort order (asc/desc)

setSortDir

public void setSortDir(String sortDir)

Parameters:

sortDir - Sort order (asc/desc)

setDir

public void setDir(String sortDir)

Parameters:

sortDir - Sort order (asc/desc)

getDir

public String getDir()

Returns:

Sort order (asc/desc)

getSearchResult

public org.displaytag.pagination.PaginatedList getSearchResult()

Returns:

the search result

prepareQuery

public abstract SearchQuery prepareQuery(String sortField,
                                         String sortOrder)

Parameters:

sortField - the field on which data is to be sorted. This will be same as the value of "property" attribute in display:column tag (when sortable=true and user clicks on the column to sort it). In case no sorting is required, this parameter will be passed as null.

sortOrder - the sort order (asc/desc)

Returns:

the query to be used for fetching the search results.

search

public String search()

The Search action method. This will internally call the method SearchFormAction#prepareQuery() to get the query to be executed. It then executes the query and creates the paginated search result.

Returns:

success