Package org.kuali.rice.kew.impl.document
Class WorkflowDocumentImpl
java.lang.Object
org.kuali.rice.kew.impl.document.WorkflowDocumentImpl
- All Implemented Interfaces:
Serializable,DocumentContract,WorkflowDocument,WorkflowDocumentPrototype
The implementation of
WorkflowDocument. Implements WorkflowDocumentPrototype to expose
and initialization method used for construction.
NOTE: operations against document data on this are only "flushed" when an action is performed.
This class is *not* thread safe.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static classA wrapper around Document which keeps track of local changes and generates a new updated Document as necessary.protected static classA wrapper around DocumentContent which keeps track of local changes and generates a new updated DocumentContent as necessary. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidacknowledge(String annotation) voidaddAttributeDefinition(WorkflowAttributeDefinition attributeDefinition) voidaddSearchableDefinition(WorkflowAttributeDefinition searchableDefinition) voidadHocToGroup(ActionRequestType actionRequested, String annotation, String targetGroupId, String responsibilityDescription, boolean forceAction) voidadHocToGroup(ActionRequestType actionRequested, String nodeName, String annotation, String targetGroupId, String responsibilityDescription, boolean forceAction) voidadHocToGroup(ActionRequestType actionRequested, String nodeName, String annotation, String targetGroupId, String responsibilityDescription, boolean forceAction, String requestLabel) voidadHocToGroup(AdHocToGroup adHocToGroup, String annotation) voidadHocToPrincipal(ActionRequestType actionRequested, String annotation, String targetPrincipalId, String responsibilityDescription, boolean forceAction) voidadHocToPrincipal(ActionRequestType actionRequested, String nodeName, String annotation, String targetPrincipalId, String responsibilityDescription, boolean forceAction) voidadHocToPrincipal(ActionRequestType actionRequested, String nodeName, String annotation, String targetPrincipalId, String responsibilityDescription, boolean forceAction, String requestLabel) voidadHocToPrincipal(AdHocToPrincipal adHocToPrincipal, String annotation) voidvoidblanketApprove(String annotation) voidblanketApprove(String annotation, String... nodeNames) voidbooleancheckStatus(DocumentStatus status) voidvoidvoidvoidvoidprotected DocumentActionParametersconstructDocumentActionParameters(String annotation) voiddelete()voiddisapprove(String annotation) voidfyi()voidorg.joda.time.DateTimeorg.joda.time.DateTimeorg.joda.time.DateTimeorg.joda.time.DateTimeorg.joda.time.DateTimeprotected DocumentContentUpdateprotected DocumentUpdateprotected StringgetFutureRequestsKey(String principalId) protected WorkflowDocumentImpl.ModifiableDocumentReturns the principalId with which this WorkflowDocument was constructedgetTitle()getVariableValue(String name) voidInitialize the WorkflowDocumentbooleanbooleanbooleanIndicates if the document is in the Processed or Finalized state.booleanbooleanIndicates if the document is in the canceled state or not.booleanbooleanIndicates if the document is in the disapproved state or not.booleanIndicates if the document is in the enroute state or not.booleanIndicates if the document is in the exception state or not.booleanisFinal()Indicates if the document is in the final state or not.booleanbooleanIndicates if the document is in the initiated state or not.booleanIndicates if the document is in the processed state or not.booleanIndicates if the document is in the recalled state or not.booleanbooleanisSaved()Indicates if the document is in the saved state or not.booleanisValidAction(ActionType actionType) voidlogAnnotation(String annotation) voidvoidplaceInExceptionRouting(String annotation) voidvoidrefresh()voidreleaseGroupAuthority(String annotation, String groupId) voidremoveAttributeDefinition(WorkflowAttributeDefinition attributeDefinition) voidremoveSearchableDefinition(WorkflowAttributeDefinition searchableDefinition) protected voidresetStateAfterAction(DocumentActionResult response) voidreturnToPreviousNode(String annotation, String nodeName) voidreturnToPreviousNode(String annotation, ReturnPoint returnPoint) voidrevokeAdHocRequestById(String actionRequestId, String annotation) voidrevokeAdHocRequests(AdHocRevoke revoke, String annotation) voidrevokeAllAdHocRequests(String annotation) voidvoidsaveDocument(String annotation) voidvoidsetApplicationContent(String applicationContent) voidsetApplicationDocumentId(String applicationDocumentId) voidsetApplicationDocumentStatus(String applicationDocumentStatus) voidsetAttributeContent(String attributeContent) voidvoidvoidvoidsetSearchableContent(String searchableContent) voidvoidsetVariable(String name, String value) voidsetWorkflowDocumentActionsService(WorkflowDocumentActionsService workflowDocumentActionsService) voidsetWorkflowDocumentService(WorkflowDocumentService workflowDocumentService) voidsuperUserBlanketApprove(String annotation) voidsuperUserCancel(String annotation) voidsuperUserDisapprove(String annotation) voidsuperUserNodeApprove(String nodeName, String annotation) voidsuperUserReturnToPreviousNode(ReturnPoint returnPoint, String annotation) voidsuperUserTakeRequestedAction(String actionRequestId, String annotation) voidswitchPrincipal(String principalId) voidtakeGroupAuthority(String annotation, String groupId) voidupdateDocumentContent(DocumentContentUpdate documentContentUpdate) List<? extends RemotableAttributeErrorContract> validateAttributeDefinition(WorkflowAttributeDefinition attributeDefinition)
-
Constructor Details
-
WorkflowDocumentImpl
public WorkflowDocumentImpl()
-
-
Method Details
-
init
Description copied from interface:WorkflowDocumentPrototypeInitialize the WorkflowDocument- Specified by:
initin interfaceWorkflowDocumentPrototype- Parameters:
principalId- the interacting/consuming user principal iddocument- the DTO of the document this WorkflowDocument represents
-
getWorkflowDocumentActionsService
-
setWorkflowDocumentActionsService
public void setWorkflowDocumentActionsService(WorkflowDocumentActionsService workflowDocumentActionsService) -
getWorkflowDocumentService
-
setWorkflowDocumentService
-
getModifiableDocument
-
getModifiableDocumentContent
-
getDocumentId
- Specified by:
getDocumentIdin interfaceDocumentContract
-
getDocument
- Specified by:
getDocumentin interfaceWorkflowDocument
-
getDocumentContent
- Specified by:
getDocumentContentin interfaceWorkflowDocument
-
getApplicationContent
- Specified by:
getApplicationContentin interfaceWorkflowDocument
-
setApplicationContent
- Specified by:
setApplicationContentin interfaceWorkflowDocument
-
setAttributeContent
- Specified by:
setAttributeContentin interfaceWorkflowDocument
-
clearAttributeContent
public void clearAttributeContent()- Specified by:
clearAttributeContentin interfaceWorkflowDocument
-
getAttributeContent
- Specified by:
getAttributeContentin interfaceWorkflowDocument
-
addAttributeDefinition
- Specified by:
addAttributeDefinitionin interfaceWorkflowDocument
-
removeAttributeDefinition
- Specified by:
removeAttributeDefinitionin interfaceWorkflowDocument
-
clearAttributeDefinitions
public void clearAttributeDefinitions()- Specified by:
clearAttributeDefinitionsin interfaceWorkflowDocument
-
getAttributeDefinitions
- Specified by:
getAttributeDefinitionsin interfaceWorkflowDocument
-
setSearchableContent
- Specified by:
setSearchableContentin interfaceWorkflowDocument
-
addSearchableDefinition
- Specified by:
addSearchableDefinitionin interfaceWorkflowDocument
-
removeSearchableDefinition
- Specified by:
removeSearchableDefinitionin interfaceWorkflowDocument
-
clearSearchableDefinitions
public void clearSearchableDefinitions()- Specified by:
clearSearchableDefinitionsin interfaceWorkflowDocument
-
clearSearchableContent
public void clearSearchableContent()- Specified by:
clearSearchableContentin interfaceWorkflowDocument
-
getSearchableDefinitions
- Specified by:
getSearchableDefinitionsin interfaceWorkflowDocument
-
validateAttributeDefinition
public List<? extends RemotableAttributeErrorContract> validateAttributeDefinition(WorkflowAttributeDefinition attributeDefinition) - Specified by:
validateAttributeDefinitionin interfaceWorkflowDocument
-
getRootActionRequests
- Specified by:
getRootActionRequestsin interfaceWorkflowDocument
-
getActionsTaken
- Specified by:
getActionsTakenin interfaceWorkflowDocument
-
setApplicationDocumentId
- Specified by:
setApplicationDocumentIdin interfaceWorkflowDocument
-
getApplicationDocumentId
- Specified by:
getApplicationDocumentIdin interfaceDocumentContract
-
getDateCreated
public org.joda.time.DateTime getDateCreated()- Specified by:
getDateCreatedin interfaceDocumentContract
-
getTitle
- Specified by:
getTitlein interfaceDocumentContract
-
getValidActions
- Specified by:
getValidActionsin interfaceWorkflowDocument
-
getRequestedActions
- Specified by:
getRequestedActionsin interfaceWorkflowDocument
-
getDocumentUpdateIfDirty
-
getDocumentContentUpdateIfDirty
-
resetStateAfterAction
-
saveDocument
- Specified by:
saveDocumentin interfaceWorkflowDocument
-
route
- Specified by:
routein interfaceWorkflowDocument
-
disapprove
- Specified by:
disapprovein interfaceWorkflowDocument
-
approve
- Specified by:
approvein interfaceWorkflowDocument
-
cancel
- Specified by:
cancelin interfaceWorkflowDocument
-
recall
- Specified by:
recallin interfaceWorkflowDocument
-
blanketApprove
- Specified by:
blanketApprovein interfaceWorkflowDocument
-
blanketApprove
- Specified by:
blanketApprovein interfaceWorkflowDocument
-
saveDocumentData
public void saveDocumentData()- Specified by:
saveDocumentDatain interfaceWorkflowDocument
-
setApplicationDocumentStatus
- Specified by:
setApplicationDocumentStatusin interfaceWorkflowDocument
-
acknowledge
- Specified by:
acknowledgein interfaceWorkflowDocument
-
fyi
- Specified by:
fyiin interfaceWorkflowDocument
-
fyi
public void fyi()- Specified by:
fyiin interfaceWorkflowDocument
-
delete
public void delete()- Specified by:
deletein interfaceWorkflowDocument
-
refresh
public void refresh()- Specified by:
refreshin interfaceWorkflowDocument
-
adHocToPrincipal
public void adHocToPrincipal(ActionRequestType actionRequested, String annotation, String targetPrincipalId, String responsibilityDescription, boolean forceAction) - Specified by:
adHocToPrincipalin interfaceWorkflowDocument
-
adHocToPrincipal
public void adHocToPrincipal(ActionRequestType actionRequested, String nodeName, String annotation, String targetPrincipalId, String responsibilityDescription, boolean forceAction) - Specified by:
adHocToPrincipalin interfaceWorkflowDocument
-
adHocToPrincipal
public void adHocToPrincipal(ActionRequestType actionRequested, String nodeName, String annotation, String targetPrincipalId, String responsibilityDescription, boolean forceAction, String requestLabel) - Specified by:
adHocToPrincipalin interfaceWorkflowDocument
-
adHocToPrincipal
- Specified by:
adHocToPrincipalin interfaceWorkflowDocument
-
adHocToGroup
public void adHocToGroup(ActionRequestType actionRequested, String annotation, String targetGroupId, String responsibilityDescription, boolean forceAction) - Specified by:
adHocToGroupin interfaceWorkflowDocument
-
adHocToGroup
public void adHocToGroup(ActionRequestType actionRequested, String nodeName, String annotation, String targetGroupId, String responsibilityDescription, boolean forceAction) - Specified by:
adHocToGroupin interfaceWorkflowDocument
-
adHocToGroup
public void adHocToGroup(ActionRequestType actionRequested, String nodeName, String annotation, String targetGroupId, String responsibilityDescription, boolean forceAction, String requestLabel) - Specified by:
adHocToGroupin interfaceWorkflowDocument
-
adHocToGroup
- Specified by:
adHocToGroupin interfaceWorkflowDocument
-
revokeAdHocRequestById
- Specified by:
revokeAdHocRequestByIdin interfaceWorkflowDocument
-
revokeAdHocRequests
- Specified by:
revokeAdHocRequestsin interfaceWorkflowDocument
-
revokeAllAdHocRequests
- Specified by:
revokeAllAdHocRequestsin interfaceWorkflowDocument
-
setTitle
- Specified by:
setTitlein interfaceWorkflowDocument
-
getDocumentTypeName
- Specified by:
getDocumentTypeNamein interfaceDocumentContract
-
isCompletionRequested
public boolean isCompletionRequested()- Specified by:
isCompletionRequestedin interfaceWorkflowDocument
-
isApprovalRequested
public boolean isApprovalRequested()- Specified by:
isApprovalRequestedin interfaceWorkflowDocument
-
isAcknowledgeRequested
public boolean isAcknowledgeRequested()- Specified by:
isAcknowledgeRequestedin interfaceWorkflowDocument
-
isFYIRequested
public boolean isFYIRequested()- Specified by:
isFYIRequestedin interfaceWorkflowDocument
-
isBlanketApproveCapable
public boolean isBlanketApproveCapable()- Specified by:
isBlanketApproveCapablein interfaceWorkflowDocument
-
isRouteCapable
public boolean isRouteCapable()- Specified by:
isRouteCapablein interfaceWorkflowDocument
-
isValidAction
- Specified by:
isValidActionin interfaceWorkflowDocument
-
superUserBlanketApprove
- Specified by:
superUserBlanketApprovein interfaceWorkflowDocument
-
superUserNodeApprove
- Specified by:
superUserNodeApprovein interfaceWorkflowDocument
-
superUserTakeRequestedAction
- Specified by:
superUserTakeRequestedActionin interfaceWorkflowDocument
-
superUserDisapprove
- Specified by:
superUserDisapprovein interfaceWorkflowDocument
-
superUserCancel
- Specified by:
superUserCancelin interfaceWorkflowDocument
-
superUserReturnToPreviousNode
- Specified by:
superUserReturnToPreviousNodein interfaceWorkflowDocument
-
complete
- Specified by:
completein interfaceWorkflowDocument
-
logAnnotation
- Specified by:
logAnnotationin interfaceWorkflowDocument
-
getStatus
- Specified by:
getStatusin interfaceDocumentContract
-
checkStatus
- Specified by:
checkStatusin interfaceWorkflowDocument
-
isInitiated
public boolean isInitiated()Indicates if the document is in the initiated state or not.- Specified by:
isInitiatedin interfaceWorkflowDocument- Returns:
- true if in the specified state
-
isSaved
public boolean isSaved()Indicates if the document is in the saved state or not.- Specified by:
isSavedin interfaceWorkflowDocument- Returns:
- true if in the specified state
-
isEnroute
public boolean isEnroute()Indicates if the document is in the enroute state or not.- Specified by:
isEnroutein interfaceWorkflowDocument- Returns:
- true if in the specified state
-
isException
public boolean isException()Indicates if the document is in the exception state or not.- Specified by:
isExceptionin interfaceWorkflowDocument- Returns:
- true if in the specified state
-
isCanceled
public boolean isCanceled()Indicates if the document is in the canceled state or not.- Specified by:
isCanceledin interfaceWorkflowDocument- Returns:
- true if in the specified state
-
isRecalled
public boolean isRecalled()Indicates if the document is in the recalled state or not.- Specified by:
isRecalledin interfaceWorkflowDocument- Returns:
- true if in the specified state
-
isDisapproved
public boolean isDisapproved()Indicates if the document is in the disapproved state or not.- Specified by:
isDisapprovedin interfaceWorkflowDocument- Returns:
- true if in the specified state
-
isApproved
public boolean isApproved()Indicates if the document is in the Processed or Finalized state.- Specified by:
isApprovedin interfaceWorkflowDocument- Returns:
- true if in the specified state
-
isProcessed
public boolean isProcessed()Indicates if the document is in the processed state or not.- Specified by:
isProcessedin interfaceWorkflowDocument- Returns:
- true if in the specified state
-
isFinal
public boolean isFinal()Indicates if the document is in the final state or not.- Specified by:
isFinalin interfaceWorkflowDocument- Returns:
- true if in the specified state
-
getPrincipalId
Returns the principalId with which this WorkflowDocument was constructed- Specified by:
getPrincipalIdin interfaceWorkflowDocument- Returns:
- the principalId with which this WorkflowDocument was constructed
-
switchPrincipal
- Specified by:
switchPrincipalin interfaceWorkflowDocument
-
takeGroupAuthority
- Specified by:
takeGroupAuthorityin interfaceWorkflowDocument
-
releaseGroupAuthority
- Specified by:
releaseGroupAuthorityin interfaceWorkflowDocument
-
getNodeNames
- Specified by:
getNodeNamesin interfaceWorkflowDocument
-
getSimpleNodeNames
- Specified by:
getSimpleNodeNamesin interfaceWorkflowDocument
-
getCurrentNodeNames
- Specified by:
getCurrentNodeNamesin interfaceWorkflowDocument
-
getCurrentSimpleNodeNames
- Specified by:
getCurrentSimpleNodeNamesin interfaceWorkflowDocument
-
returnToPreviousNode
- Specified by:
returnToPreviousNodein interfaceWorkflowDocument
-
returnToPreviousNode
- Specified by:
returnToPreviousNodein interfaceWorkflowDocument
-
move
- Specified by:
movein interfaceWorkflowDocument
-
getActiveRouteNodeInstances
- Specified by:
getActiveRouteNodeInstancesin interfaceWorkflowDocument
-
getCurrentRouteNodeInstances
- Specified by:
getCurrentRouteNodeInstancesin interfaceWorkflowDocument
-
getRouteNodeInstances
- Specified by:
getRouteNodeInstancesin interfaceWorkflowDocument
-
getPreviousNodeNames
- Specified by:
getPreviousNodeNamesin interfaceWorkflowDocument
-
getDocumentDetail
- Specified by:
getDocumentDetailin interfaceWorkflowDocument
-
updateDocumentContent
- Specified by:
updateDocumentContentin interfaceWorkflowDocument
-
placeInExceptionRouting
- Specified by:
placeInExceptionRoutingin interfaceWorkflowDocument
-
setVariable
- Specified by:
setVariablein interfaceWorkflowDocument
-
getVariableValue
- Specified by:
getVariableValuein interfaceWorkflowDocument
-
setReceiveFutureRequests
public void setReceiveFutureRequests()- Specified by:
setReceiveFutureRequestsin interfaceWorkflowDocument
-
setDoNotReceiveFutureRequests
public void setDoNotReceiveFutureRequests()- Specified by:
setDoNotReceiveFutureRequestsin interfaceWorkflowDocument
-
setClearFutureRequests
public void setClearFutureRequests()- Specified by:
setClearFutureRequestsin interfaceWorkflowDocument
-
getFutureRequestsKey
-
getReceiveFutureRequestsValue
- Specified by:
getReceiveFutureRequestsValuein interfaceWorkflowDocument
-
getDoNotReceiveFutureRequestsValue
- Specified by:
getDoNotReceiveFutureRequestsValuein interfaceWorkflowDocument
-
getClearFutureRequestsValue
- Specified by:
getClearFutureRequestsValuein interfaceWorkflowDocument
-
constructDocumentActionParameters
-
getDateLastModified
public org.joda.time.DateTime getDateLastModified()- Specified by:
getDateLastModifiedin interfaceDocumentContract
-
getDateApproved
public org.joda.time.DateTime getDateApproved()- Specified by:
getDateApprovedin interfaceDocumentContract
-
getDateFinalized
public org.joda.time.DateTime getDateFinalized()- Specified by:
getDateFinalizedin interfaceDocumentContract
-
getInitiatorPrincipalId
- Specified by:
getInitiatorPrincipalIdin interfaceDocumentContract
-
getRoutedByPrincipalId
- Specified by:
getRoutedByPrincipalIdin interfaceDocumentContract
-
getDocumentTypeId
- Specified by:
getDocumentTypeIdin interfaceDocumentContract
-
getDocumentHandlerUrl
- Specified by:
getDocumentHandlerUrlin interfaceDocumentContract
-
getApplicationDocumentStatus
- Specified by:
getApplicationDocumentStatusin interfaceDocumentContract
-
getApplicationDocumentStatusDate
public org.joda.time.DateTime getApplicationDocumentStatusDate()- Specified by:
getApplicationDocumentStatusDatein interfaceDocumentContract
-
getVariables
- Specified by:
getVariablesin interfaceDocumentContract
-