org.kuali.rice.kew.actionlist.web

Class ActionListForm

java.lang.Object

org.apache.struts.action.ActionForm

org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

org.kuali.rice.kns.web.struts.form.KualiForm

org.kuali.rice.kew.actionlist.web.ActionListForm

All Implemented Interfaces:

Serializable, PojoForm

public class ActionListForm
extends KualiForm

Struts form for action ActionListAction

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

KualiForm.TabState

Field Summary

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

extraButtons

Fields inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

requiredNonEditableProperties

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Constructor Summary

Constructors

Constructor and Description
ActionListForm()

Method Summary

Methods

Modifier and Type	Method and Description
String	getActionListType()
ActionToTake	getActions(int index)
List<ActionToTake>	getActionsToTake()
int	getCount()
String	getCssFile()
String	getCurrentDir()
Integer	getCurrentPage()
String	getCurrentSort()
Boolean	getCustomActionList()
Map<?,?>	getDefaultActions()
String	getDefaultActionToTake()
String	getDelegationId()
String	getDelegator()
List<?>	getDelegators()
String	getDir()
String	getDocType()
Boolean	getDocumentPopup()
String	getFilterLegend()
Boolean	getHasCustomActions()
Boolean	getHasDisplayParameters()
List<ExtraButton>	getHeaderButtons()
String	getHelpDeskActionListUserName()
String	getLogoAlign()
String	getMenuBar()
String	getMethodToCall() Used by the dispatch action to determine which action method to call into.
String[]	getOutboxItems()
Integer	getPage()
String	getPrimaryDelegateId()
List<WebFriendlyRecipient>	getPrimaryDelegates()
Boolean	getRouteLogPopup()
Boolean	getShowOutbox()
String	getSort()
String	getViewOutbox()
boolean	isOutBoxEmpty()
void	populate(javax.servlet.http.HttpServletRequest request) Checks for methodToCall parameter, and if not populated in form calls utility method to parse the string from the request.
void	setActionListType(String actionListType)
void	setActionsToTake(List<ActionToTake> actionsToTake)
void	setCount(int count)
void	setCssFile(String cssFile)
void	setCurrentDir(String currentDir)
void	setCurrentPage(Integer currentPage)
void	setCurrentSort(String currentSort)
void	setCustomActionList(Boolean customActionList)
void	setDefaultActions(Map<?,?> defaultActions)
void	setDefaultActionToTake(String defaultActionToTake)
void	setDelegationId(String delegationId)
void	setDelegator(String delegator)
void	setDelegators(List<?> delegators)
void	setDir(String dir)
void	setDocType(String docType)
void	setDocumentPopup(Boolean documentPopup)
void	setFilterLegend(String filterLegend)
void	setHasCustomActions(Boolean hasCustomActions)
void	setHasDisplayParameters(Boolean hasDisplayParameters)
void	setHeaderButtons(List<ExtraButton> headerButtons)
void	setHelpDeskActionListUserName(String helpDeskActionListUserName)
void	setLogoAlign(String logoAlign)
void	setMethodToCall(String methodToCall)
void	setOutBoxEmpty(boolean outBoxEmpty)
void	setOutboxItems(String[] outboxItems)
void	setPage(Integer page)
void	setPrimaryDelegateId(String primaryDelegateId)
void	setPrimaryDelegates(List<WebFriendlyRecipient> primaryDelegates)
void	setRouteLogPopup(Boolean routeLogPopup)
void	setShowOutbox(Boolean showOutbox)
void	setSort(String sort)
void	setViewOutbox(String viewOutbox)

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

addRequiredNonEditableProperties, clearEditablePropertyInformation, getActionFormUtilMap, getAnchor, getBackLocation, getCurrentTabIndex, getDisplayedErrors, getDisplayedInfo, getDisplayedWarnings, getDocInfo, getExtraButton, getExtraButtons, getFieldNameToFocusOnAfterSubmit, getHeaderNavigationTabs, getNavigationCss, getNextArbitrarilyHighIndex, getNumColumns, getRefreshCaller, getTabState, getTabStates, incrementTabIndex, isFieldLevelHelpEnabled, populateBackLocation, populateFieldLevelHelpEnabled, reset, reset, retrieveFormValueForLookupInquiryParameters, setActionFormUtilMap, setAnchor, setBackLocation, setCurrentTabIndex, setDerivedValuesOnForm, setDocInfo, setExtraButton, setExtraButtons, setFieldLevelHelpEnabled, setFieldNameToFocusOnAfterSubmit, setHeaderNavigationTabs, setNavigationCss, setNumColumns, setRefreshCaller, setTabStates, shouldMethodToCallParameterBeUsed, shouldPropertyBePopulatedInForm

Methods inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

addMaxUploadSize, cacheUnconvertedValue, copyPopulateEditablePropertiesToActionEditableProperties, customInitMaxUploadSizes, formatterClassForKeypath, formatValue, getActionEditablePropertiesGuid, getEditableProperties, getFormatter, getFormatterTypes, getIsNewForm, getMaxUploadSizes, getMethodToCallsToBypassSessionRetrievalForGETRequests, getParameter, getParameterValues, getPopulateEditableProperties, getPopulateEditablePropertiesGuid, getPropertyType, getRequiredNonEditableProperties, getStrutsActionMappingScope, getUnconvertedValues, getUnknownKeys, initMaxUploadSizes, isPropertyEditable, isPropertyNonEditableButRequired, populateForProperty, postprocessRequestParameters, processValidationFail, registerEditableProperty, registerIsNewForm, registerRequiredNonEditableProperty, registerStrutsActionMappingScope, setActionEditablePropertiesGuid, setFormatterType, setFormatterTypes, setPopulateEditablePropertiesGuid, setUnconvertedValues

Methods inherited from class org.apache.struts.action.ActionForm

getMultipartRequestHandler, getServlet, getServletWrapper, setMultipartRequestHandler, setServlet, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionListForm

public ActionListForm()

Method Detail

getHelpDeskActionListUserName

public String getHelpDeskActionListUserName()

setHelpDeskActionListUserName

public void setHelpDeskActionListUserName(String helpDeskActionListUserName)

getMethodToCall

public String getMethodToCall()

Description copied from class: KualiForm

Used by the dispatch action to determine which action method to call into.

Overrides:

getMethodToCall in class KualiForm

Returns:

Returns the methodToCall.

setMethodToCall

public void setMethodToCall(String methodToCall)

Overrides:

setMethodToCall in class KualiForm

Parameters:

methodToCall - The methodToCall to set.

getDelegator

public String getDelegator()

setDelegator

public void setDelegator(String delegator)

getDocType

public String getDocType()

setDocType

public void setDocType(String docType)

getFilterLegend

public String getFilterLegend()

setFilterLegend

public void setFilterLegend(String filterLegend)

getActionListType

public String getActionListType()

setActionListType

public void setActionListType(String actionListType)

getCustomActionList

public Boolean getCustomActionList()

setCustomActionList

public void setCustomActionList(Boolean customActionList)

getDefaultActionToTake

public String getDefaultActionToTake()

setDefaultActionToTake

public void setDefaultActionToTake(String defaultActionToTake)

getActionsToTake

public List<ActionToTake> getActionsToTake()

setActionsToTake

public void setActionsToTake(List<ActionToTake> actionsToTake)

getActions

public ActionToTake getActions(int index)

getDefaultActions

public Map<?,?> getDefaultActions()

setDefaultActions

public void setDefaultActions(Map<?,?> defaultActions)

getDelegationId

public String getDelegationId()

setDelegationId

public void setDelegationId(String delegationId)

getDelegators

public List<?> getDelegators()

setDelegators

public void setDelegators(List<?> delegators)

getHasCustomActions

public Boolean getHasCustomActions()

setHasCustomActions

public void setHasCustomActions(Boolean hasCustomActions)

getDir

public String getDir()

setDir

public void setDir(String dir)

getPage

public Integer getPage()

setPage

public void setPage(Integer page)

getSort

public String getSort()

setSort

public void setSort(String sort)

getCurrentPage

public Integer getCurrentPage()

setCurrentPage

public void setCurrentPage(Integer currentPage)

getCurrentDir

public String getCurrentDir()

setCurrentDir

public void setCurrentDir(String currentDir)

getCurrentSort

public String getCurrentSort()

setCurrentSort

public void setCurrentSort(String currentSort)

getCount

public int getCount()

setCount

public void setCount(int count)

getCssFile

public String getCssFile()

setCssFile

public void setCssFile(String cssFile)

getLogoAlign

public String getLogoAlign()

setLogoAlign

public void setLogoAlign(String logoAlign)

getViewOutbox

public String getViewOutbox()

setViewOutbox

public void setViewOutbox(String viewOutbox)

getOutboxItems

public String[] getOutboxItems()

setOutboxItems

public void setOutboxItems(String[] outboxItems)

isOutBoxEmpty

public boolean isOutBoxEmpty()

setOutBoxEmpty

public void setOutBoxEmpty(boolean outBoxEmpty)

getShowOutbox

public Boolean getShowOutbox()

setShowOutbox

public void setShowOutbox(Boolean showOutbox)

getHeaderButtons

public List<ExtraButton> getHeaderButtons()

setHeaderButtons

public void setHeaderButtons(List<ExtraButton> headerButtons)

getMenuBar

public String getMenuBar()

populate

public void populate(javax.servlet.http.HttpServletRequest request)

Description copied from class: KualiForm

Checks for methodToCall parameter, and if not populated in form calls utility method to parse the string from the request.

Specified by:

populate in interface PojoForm

Overrides:

populate in class KualiForm

getRouteLogPopup

public Boolean getRouteLogPopup()

getDocumentPopup

public Boolean getDocumentPopup()

setRouteLogPopup

public void setRouteLogPopup(Boolean routeLogPopup)

setDocumentPopup

public void setDocumentPopup(Boolean documentPopup)

getHasDisplayParameters

public Boolean getHasDisplayParameters()

setHasDisplayParameters

public void setHasDisplayParameters(Boolean hasDisplayParameters)

getPrimaryDelegates

public List<WebFriendlyRecipient> getPrimaryDelegates()

setPrimaryDelegates

public void setPrimaryDelegates(List<WebFriendlyRecipient> primaryDelegates)

getPrimaryDelegateId

public String getPrimaryDelegateId()

setPrimaryDelegateId

public void setPrimaryDelegateId(String primaryDelegateId)