org.kuali.rice.krad.web.form

Class DocumentFormBase

java.lang.Object

org.kuali.rice.krad.web.form.UifFormBase

org.kuali.rice.krad.web.form.DocumentFormBase

All Implemented Interfaces:

Serializable, ViewModel

Direct Known Subclasses:

MaintenanceDocumentForm, TransactionalDocumentFormBase

public class DocumentFormBase
extends UifFormBase

Base form for all DocumentView screens

Author:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Document	document

Fields inherited from class org.kuali.rice.krad.web.form.UifFormBase

actionParameters, addedCollectionItems, ajaxRequest, ajaxReturnType, applyDefaultValues, attachmentFile, clientStateForSyncing, controllerMapping, dialogExplanations, dialogResponses, dirtyForm, extensionData, flowKey, focusId, formKey, formPostUrl, growlScript, historyFlow, historyManager, jumpToId, jumpToName, methodToCall, newCollectionLines, pageId, queryParameters, readOnlyFieldsList, renderedInIframe, renderedInLightBox, requestedFormKey, requestRedirected, returnDialogId, returnDialogResponse, returnFormKey, returnLocation, selectedCollectionLines, selectedLookupResultsCache, sessionId, sessionTimeoutInterval, state, triggerActionId, updateComponentId, view, viewId, viewName, viewPostMetadata, viewRequestParameters, viewTypeName

Constructor Summary

Constructors

Constructor and Description
DocumentFormBase()

Method Summary

Methods

Modifier and Type	Method and Description
List<ActionRequest>	getActionRequests()
List<ActionRequest>	getActionRequestsRequiringApproval()
String	getAnnotation()
String	getCommand()
protected String	getDefaultDocumentTypeName()
String	getDocId()
String	getDocTypeName()
Document	getDocument()
String	getDocumentCreateDate() Retrieves the create date for the forms document and formats for presentation
String	getDocumentInitiatorNetworkId() Retrieves the principal name (network id) for the document's initiator
WorkflowDocument	getWorkflowDocument() Retrieves the WorkflowDocument instance from the forms document instance
protected void	instantiateDocument()
boolean	isStateAllowsApproveOrDisapprove()
boolean	isStateAllowsApproveSingleActionRequest()
boolean	isStateInitiatedFinalCancelled(DocumentStatus status)
boolean	isStateProcessedOrDisapproved(DocumentStatus status)
boolean	isSuperUserActionAvaliable()
boolean	isSuperUserApproveDocumentAuthorized()
boolean	isSuperUserApproveSingleActionRequestAuthorized()
boolean	isSuperUserAuthorized()
boolean	isSuperUserDisapproveDocumentAuthorized()
void	setAnnotation(String annotation)
void	setCommand(String command)
void	setDocId(String docId)
void	setDocTypeName(String docTypeName)
void	setDocument(Document document)

Methods inherited from class org.kuali.rice.krad.web.form.UifFormBase

generateFormKey, getActionEvent, getActionParamaterValue, getActionParameters, getActionParametersAsProperties, getAddedCollectionItems, getAjaxReturnType, getAttachmentFile, getClientStateForSyncing, getControllerMapping, getDialogExplanations, getDialogResponse, getDialogResponses, getExtensionData, getFiles, getFlowKey, getFocusId, getFormKey, getFormPostUrl, getGrowlScript, getHistoryFlow, getHistoryManager, getInitialRequestParameters, getJumpToId, getJumpToName, getMethodToCall, getNewCollectionLines, getPageId, getQueryParameters, getReadOnlyFieldsList, getRequestedFormKey, getRequestJsonTemplate, getRequestUrl, getReturnDialogId, getReturnDialogResponse, getReturnFormKey, getReturnLocation, getSelectedCollectionLines, getSelectedLookupResultsCache, getSessionId, getSessionTimeoutInterval, getState, getTriggerActionId, getUpdateComponent, getUpdateComponentId, getView, getViewHelperService, getViewId, getViewName, getViewPostMetadata, getViewRequestParameters, getViewService, getViewTypeName, isAddedCollectionItem, isAjaxRequest, isApplyDefaultValues, isCollectionPagingRequest, isDirtyForm, isJsonRequest, isRenderedInIframe, isRenderedInLightBox, isRequestRedirected, isUpdateComponentRequest, isUpdateDialogRequest, isUpdateNoneRequest, isUpdatePageRequest, postBind, preBind, preRender, setActionParameters, setAddedCollectionItems, setAjaxRequest, setAjaxReturnType, setApplyDefaultValues, setAttachmentFile, setClientStateForSyncing, setCollectionPagingRequest, setDialogExplanations, setDialogResponses, setDirtyForm, setDirtyForm, setExtensionData, setFlowKey, setFocusId, setFormKey, setFormPostUrl, setGrowlScript, setHistoryFlow, setHistoryManager, setInitialRequestParameters, setJumpToId, setJumpToName, setMethodToCall, setNewCollectionLines, setPageId, setQueryParameters, setReadOnlyFieldsList, setRenderedInIframe, setRenderedInLightBox, setRequestedFormKey, setRequestJsonTemplate, setRequestRedirected, setRequestUrl, setReturnDialogId, setReturnDialogResponse, setReturnFormKey, setReturnLocation, setSelectedCollectionLines, setSelectedLookupResultsCache, setState, setTriggerActionId, setUpdateComponent, setUpdateComponentId, setView, setViewId, setViewName, setViewPostMetadata, setViewRequestParameters, setViewTypeName, toString

Methods inherited from class java.lang.Object

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

Field Detail

document

protected Document document

Constructor Detail

DocumentFormBase

public DocumentFormBase()

Method Detail

getAnnotation

public String getAnnotation()

setAnnotation

public void setAnnotation(String annotation)

getDocument

public Document getDocument()

setDocument

public void setDocument(Document document)

getDocTypeName

public String getDocTypeName()

setDocTypeName

public void setDocTypeName(String docTypeName)

getCommand

public String getCommand()

setCommand

public void setCommand(String command)

getDocId

public String getDocId()

setDocId

public void setDocId(String docId)

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

instantiateDocument

protected void instantiateDocument()

getDocumentInitiatorNetworkId

public String getDocumentInitiatorNetworkId()

Retrieves the principal name (network id) for the document's initiator

Returns:

String initiator name

getDocumentCreateDate

public String getDocumentCreateDate()

Retrieves the create date for the forms document and formats for presentation

Returns:

String formatted document create date

getWorkflowDocument

public WorkflowDocument getWorkflowDocument()

Retrieves the WorkflowDocument instance from the forms document instance

Returns:

WorkflowDocument for the forms document

getActionRequests

public List<ActionRequest> getActionRequests()

getActionRequestsRequiringApproval

public List<ActionRequest> getActionRequestsRequiringApproval()

isSuperUserActionAvaliable

public boolean isSuperUserActionAvaliable()

isSuperUserApproveSingleActionRequestAuthorized

public boolean isSuperUserApproveSingleActionRequestAuthorized()

isSuperUserApproveDocumentAuthorized

public boolean isSuperUserApproveDocumentAuthorized()

isSuperUserDisapproveDocumentAuthorized

public boolean isSuperUserDisapproveDocumentAuthorized()

isSuperUserAuthorized

public boolean isSuperUserAuthorized()

isStateAllowsApproveOrDisapprove

public boolean isStateAllowsApproveOrDisapprove()

isStateAllowsApproveSingleActionRequest

public boolean isStateAllowsApproveSingleActionRequest()

isStateProcessedOrDisapproved

public boolean isStateProcessedOrDisapproved(DocumentStatus status)

isStateInitiatedFinalCancelled

public boolean isStateInitiatedFinalCancelled(DocumentStatus status)