Package 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	Description
protected Document	document

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

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

Constructor Summary

Constructors

Constructor	Description
DocumentFormBase()

Method Summary

Modifier and Type	Method	Description
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
org.kuali.rice.kew.api.WorkflowDocument	getWorkflowDocument()	Retrieves the WorkflowDocument instance from the forms document instance
protected void	instantiateDocument()
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, getActionFlags, getActionParamaterValue, getActionParameters, getActionParametersAsProperties, getAddedCollectionItems, getAjaxReturnType, getAttachmentFile, getClientStateForSyncing, getControllerMapping, getCsrfToken, getDialogDataObject, getDialogExplanations, getDialogResponse, getDialogResponses, getEditModes, getExtensionData, getFlowKey, getFocusId, getFormKey, getFormPostUrl, getGrowlScript, getHistoryFlow, getHistoryManager, getInitialRequestParameters, getJumpToId, getJumpToName, getMethodToCall, getNewCollectionLines, getPageId, getReadOnlyFieldsList, getRequest, getRequestedFormKey, getRequestJsonTemplate, getRequestUrl, getReturnDialogId, getReturnDialogResponse, getReturnFormKey, getReturnLocation, getSelectedCollectionLines, getSelectedLookupResultsCache, getSessionId, getSessionTimeoutInterval, getShowDialogId, getState, getTriggerActionId, getUpdateComponent, getUpdateComponentId, getView, getViewHelperService, getViewId, getViewName, getViewPostMetadata, getViewRequestParameters, getViewService, getViewTypeName, isAddedCollectionItem, isAjaxRequest, isApplyDefaultValues, isCanEditView, isCollectionPagingRequest, isDirtyForm, isEvaluateFlagsAndModes, isJsonRequest, isRenderedInDialog, isRenderedInIframe, isRequestRedirected, isUpdateComponentRequest, isUpdateDialogRequest, isUpdateNoneRequest, isUpdatePageRequest, postBind, preBind, preRender, setActionFlags, setActionParameters, setAddedCollectionItems, setAjaxRequest, setAjaxReturnType, setApplyDefaultValues, setAttachmentFile, setCanEditView, setClientStateForSyncing, setCollectionPagingRequest, setCsrfToken, setDialogDataObject, setDialogExplanations, setDialogResponses, setDirtyForm, setDirtyForm, setEditModes, setEvaluateFlagsAndModes, setExtensionData, setFlowKey, setFocusId, setFormKey, setFormPostUrl, setGrowlScript, setHistoryFlow, setHistoryManager, setInitialRequestParameters, setJumpToId, setJumpToName, setMethodToCall, setNewCollectionLines, setPageId, setReadOnlyFieldsList, setRenderedInDialog, setRenderedInIframe, setRequest, setRequestedFormKey, setRequestJsonTemplate, setRequestRedirected, setRequestUrl, setReturnDialogId, setReturnDialogResponse, setReturnFormKey, setReturnLocation, setSelectedCollectionLines, setSelectedLookupResultsCache, setShowDialogId, 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 Details

document

protected Document document

Constructor Details

DocumentFormBase

public DocumentFormBase()

Method Details

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 org.kuali.rice.kew.api.WorkflowDocument getWorkflowDocument()

Retrieves the WorkflowDocument instance from the forms document instance

Returns:

WorkflowDocument for the forms document