org.kuali.rice.kew.routelog.web

Class RouteLogForm

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.routelog.web.RouteLogForm

All Implemented Interfaces:

Serializable, PojoForm

public class RouteLogForm
extends KualiForm

The Struts ActionForm used with RouteLogAction to display the routelog.

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
RouteLogForm()

Method Summary

Modifier and Type	Method and Description
String	getDocId()
String	getDocumentId()
int	getFutureActionRequestCount()
List	getFutureRootRequests()
String	getHeaderMenuBar()
String	getMethodToCall() Used by the dispatch action to determine which action method to call into.
String	getNewRouteLogActionMessage()
int	getPendingActionRequestCount()
String	getReturnUrlLocation()
List	getRootRequests()
String	getShowFutureError()
boolean	isEnableLogAction()
boolean	isLookFuture()
boolean	isRemoveHeader()
boolean	isShowCloseButton()
boolean	isShowFuture()
boolean	isShowFutureHasError()
boolean	isShowNotes()
void	setDocId(String docId)
void	setDocumentId(String documentId)
void	setEnableLogAction(boolean enableLogAction)
void	setFutureActionRequestCount(int futureActionRequestCount)
void	setFutureRootRequests(List futureRootRequests)
void	setLookFuture(boolean showFutureLink)
void	setMethodToCall(String methodToCall)
void	setNewRouteLogActionMessage(String newRouteLogActionMessage)
void	setPendingActionRequestCount(int pendingActionRequestCount)
void	setRemoveHeader(boolean removeBar)
void	setReturnUrlLocation(String returnUrlLocation)
void	setRootRequests(List rootRequests)
void	setShowCloseButton(boolean showCloseButton)
void	setShowFuture(boolean showReportURL)
void	setShowFutureError(String showFutureError)
void	setShowNotes(boolean showNotes)

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, populate, 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

RouteLogForm

public RouteLogForm()

Method Detail

isShowCloseButton

public boolean isShowCloseButton()

setShowCloseButton

public void setShowCloseButton(boolean showCloseButton)

getReturnUrlLocation

public String getReturnUrlLocation()

setReturnUrlLocation

public void setReturnUrlLocation(String returnUrlLocation)

getDocId

public String getDocId()

setDocId

public void setDocId(String docId)

isShowFutureHasError

public boolean isShowFutureHasError()

getShowFutureError

public String getShowFutureError()

setShowFutureError

public void setShowFutureError(String showFutureError)

isShowFuture

public boolean isShowFuture()

setShowFuture

public void setShowFuture(boolean showReportURL)

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.

getDocumentId

public String getDocumentId()

setDocumentId

public void setDocumentId(String documentId)

getPendingActionRequestCount

public int getPendingActionRequestCount()

setPendingActionRequestCount

public void setPendingActionRequestCount(int pendingActionRequestCount)

getRootRequests

public List getRootRequests()

setRootRequests

public void setRootRequests(List rootRequests)

getFutureActionRequestCount

public int getFutureActionRequestCount()

setFutureActionRequestCount

public void setFutureActionRequestCount(int futureActionRequestCount)

getFutureRootRequests

public List getFutureRootRequests()

setFutureRootRequests

public void setFutureRootRequests(List futureRootRequests)

isRemoveHeader

public boolean isRemoveHeader()

setRemoveHeader

public void setRemoveHeader(boolean removeBar)

isLookFuture

public boolean isLookFuture()

setLookFuture

public void setLookFuture(boolean showFutureLink)

isShowNotes

public boolean isShowNotes()

setShowNotes

public void setShowNotes(boolean showNotes)

getNewRouteLogActionMessage

public String getNewRouteLogActionMessage()

setNewRouteLogActionMessage

public void setNewRouteLogActionMessage(String newRouteLogActionMessage)

isEnableLogAction

public boolean isEnableLogAction()

setEnableLogAction

public void setEnableLogAction(boolean enableLogAction)

getHeaderMenuBar

public String getHeaderMenuBar()