org.kuali.rice.kew.api
Interface WorkflowDocument

All Superinterfaces:

DocumentContract

All Known Subinterfaces:

WorkflowDocumentPrototype

All Known Implementing Classes:

WorkflowDocumentImpl

public interface WorkflowDocument
extends DocumentContract

TODO .. TODO - it is intended that operations against document data on this are only "flushed" when an action is performed...

This class is *not* thread safe.

Method Summary

void	acknowledge(String annotation)
void	addAttributeDefinition(WorkflowAttributeDefinition attributeDefinition)
void	addSearchableDefinition(WorkflowAttributeDefinition searchableDefinition)
void	adHocToGroup(ActionRequestType actionRequested, String annotation, String targetGroupId, String responsibilityDescription, boolean forceAction)
void	adHocToGroup(ActionRequestType actionRequested, String nodeName, String annotation, String targetGroupId, String responsibilityDescription, boolean forceAction)
void	adHocToGroup(ActionRequestType actionRequested, String nodeName, String annotation, String targetGroupId, String responsibilityDescription, boolean forceAction, String requestLabel)
void	adHocToGroup(AdHocToGroup adHocToGroup, String annotation)
void	adHocToPrincipal(ActionRequestType actionRequested, String annotation, String targetPrincipalId, String responsibilityDescription, boolean forceAction)
void	adHocToPrincipal(ActionRequestType actionRequested, String nodeName, String annotation, String targetPrincipalId, String responsibilityDescription, boolean forceAction)
void	adHocToPrincipal(ActionRequestType actionRequested, String nodeName, String annotation, String targetPrincipalId, String responsibilityDescription, boolean forceAction, String requestLabel)
void	adHocToPrincipal(AdHocToPrincipal adHocToPrincipal, String annotation)
void	approve(String annotation)
void	blanketApprove(String annotation)
void	blanketApprove(String annotation, String... nodeNames)
void	cancel(String annotation)
boolean	checkStatus(DocumentStatus status)
void	clearAttributeContent()
void	clearAttributeDefinitions()
void	clearSearchableContent()
void	clearSearchableDefinitions()
void	complete(String annotation)
void	delete() TODO - be sure to mention that once this document is deleted, this api effectively becomes "dead" when you try to execute any document operation
void	disapprove(String annotation)
void	fyi()
void	fyi(String annotation)
List<ActionTaken>	getActionsTaken()
List<RouteNodeInstance>	getActiveRouteNodeInstances()
String	getApplicationContent()
String	getApplicationDocumentId()
String	getAttributeContent()
List<WorkflowAttributeDefinition>	getAttributeDefinitions()
String	getClearFutureRequestsValue()
Set<String>	getCurrentNodeNames() Returns the names of the nodes at which the document is currently at in it's route path.
List<RouteNodeInstance>	getCurrentRouteNodeInstances()
org.joda.time.DateTime	getDateCreated()
Document	getDocument()
DocumentContent	getDocumentContent()
DocumentDetail	getDocumentDetail()
String	getDocumentId()
String	getDocumentTypeName()
String	getDoNotReceiveFutureRequestsValue()
Set<String>	getNodeNames() Returns the names of the route nodes on the document which are currently active.
List<String>	getPreviousNodeNames()
String	getPrincipalId() Returns the principalId with which this WorkflowDocument was constructed
String	getReceiveFutureRequestsValue()
RequestedActions	getRequestedActions()
List<ActionRequest>	getRootActionRequests()
List<RouteNodeInstance>	getRouteNodeInstances()
List<WorkflowAttributeDefinition>	getSearchableDefinitions()
DocumentStatus	getStatus()
String	getTitle()
ValidActions	getValidActions()
String	getVariableValue(String name)
boolean	isAcknowledgeRequested()
boolean	isApprovalRequested()
boolean	isApproved() Indicates if the document is in the Processed or Finalized state.
boolean	isBlanketApproveCapable()
boolean	isCanceled() Indicates if the document is in the canceled state or not.
boolean	isCompletionRequested()
boolean	isDisapproved() Indicates if the document is in the disapproved state or not.
boolean	isEnroute() Indicates if the document is in the enroute state or not.
boolean	isException() Indicates if the document is in the exception state or not.
boolean	isFinal() Indicates if the document is in the final state or not.
boolean	isFYIRequested()
boolean	isInitiated() Indicates if the document is in the initiated state or not.
boolean	isProcessed() Indicates if the document is in the processed state or not.
boolean	isRouteCapable()
boolean	isSaved() Indicates if the document is in the saved state or not.
boolean	isValidAction(ActionType actionType)
void	logAnnotation(String annotation)
void	move(MovePoint movePoint, String annotation)
void	placeInExceptionRouting(String annotation)
void	refresh()
void	releaseGroupAuthority(String annotation, String groupId)
void	removeAttributeDefinition(WorkflowAttributeDefinition attributeDefinition)
void	removeSearchableDefinition(WorkflowAttributeDefinition searchableDefinition)
void	returnToPreviousNode(ReturnPoint returnPoint, String annotation)
void	returnToPreviousNode(String nodeName, String annotation)
void	revokeAdHocRequestById(String actionRequestId, String annotation)
void	revokeAdHocRequests(AdHocRevoke revoke, String annotation)
void	revokeAllAdHocRequests(String annotation)
void	route(String annotation)
void	saveDocument(String annotation)
void	saveDocumentData()
void	setApplicationContent(String applicationContent)
void	setApplicationDocumentId(String applicationDocumentId)
void	setApplicationDocumentStatus(String applicationDocumentStatus)
void	setAttributeContent(String attributeContent)
void	setClearFutureRequests()
void	setDoNotReceiveFutureRequests()
void	setReceiveFutureRequests()
void	setSearchableContent(String searchableContent)
void	setTitle(String title)
void	setVariable(String name, String value)
void	superUserBlanketApprove(String annotation)
void	superUserCancel(String annotation)
void	superUserDisapprove(String annotation)
void	superUserNodeApprove(String nodeName, String annotation)
void	superUserReturnToPreviousNode(ReturnPoint returnPoint, String annotation)
void	superUserTakeRequestedAction(String actionRequestId, String annotation)
void	switchPrincipal(String principalId)
void	takeGroupAuthority(String annotation, String groupId)
void	updateDocumentContent(DocumentContentUpdate documentContentUpdate)
List<WorkflowAttributeValidationError>	validateAttributeDefinition(WorkflowAttributeDefinition attributeDefinition)

Methods inherited from interface org.kuali.rice.kew.api.document.DocumentContract

getApplicationDocumentStatus, getApplicationDocumentStatusDate, getDateApproved, getDateFinalized, getDateLastModified, getDocumentHandlerUrl, getDocumentTypeId, getInitiatorPrincipalId, getRoutedByPrincipalId, getVariables

Method Detail

getDocumentId

String getDocumentId()

Specified by:

getDocumentId in interface DocumentContract

getDocument

Document getDocument()

getDocumentContent

DocumentContent getDocumentContent()

getApplicationContent

String getApplicationContent()

setApplicationContent

void setApplicationContent(String applicationContent)

setAttributeContent

void setAttributeContent(String attributeContent)

clearAttributeContent

void clearAttributeContent()

getAttributeContent

String getAttributeContent()

addAttributeDefinition

void addAttributeDefinition(WorkflowAttributeDefinition attributeDefinition)

removeAttributeDefinition

void removeAttributeDefinition(WorkflowAttributeDefinition attributeDefinition)

clearAttributeDefinitions

void clearAttributeDefinitions()

getAttributeDefinitions

List<WorkflowAttributeDefinition> getAttributeDefinitions()

setSearchableContent

void setSearchableContent(String searchableContent)

addSearchableDefinition

void addSearchableDefinition(WorkflowAttributeDefinition searchableDefinition)

removeSearchableDefinition

void removeSearchableDefinition(WorkflowAttributeDefinition searchableDefinition)

clearSearchableDefinitions

void clearSearchableDefinitions()

clearSearchableContent

void clearSearchableContent()

getSearchableDefinitions

List<WorkflowAttributeDefinition> getSearchableDefinitions()

validateAttributeDefinition

List<WorkflowAttributeValidationError> validateAttributeDefinition(WorkflowAttributeDefinition attributeDefinition)

getRootActionRequests

List<ActionRequest> getRootActionRequests()

getActionsTaken

List<ActionTaken> getActionsTaken()

setApplicationDocumentId

void setApplicationDocumentId(String applicationDocumentId)

getApplicationDocumentId

String getApplicationDocumentId()

Specified by:

getApplicationDocumentId in interface DocumentContract

getDateCreated

org.joda.time.DateTime getDateCreated()

Specified by:

getDateCreated in interface DocumentContract

getTitle

String getTitle()

Specified by:

getTitle in interface DocumentContract

getValidActions

ValidActions getValidActions()

getRequestedActions

RequestedActions getRequestedActions()

saveDocument

void saveDocument(String annotation)

route

void route(String annotation)

disapprove

void disapprove(String annotation)

approve

void approve(String annotation)

cancel

void cancel(String annotation)

blanketApprove

void blanketApprove(String annotation)

blanketApprove

void blanketApprove(String annotation,
                    String... nodeNames)

saveDocumentData

void saveDocumentData()

setApplicationDocumentStatus

void setApplicationDocumentStatus(String applicationDocumentStatus)

acknowledge

void acknowledge(String annotation)

fyi

void fyi(String annotation)

fyi

void fyi()

delete

void delete()

TODO - be sure to mention that once this document is deleted, this api effectively becomes "dead" when you try to execute any document operation

refresh

void refresh()

adHocToPrincipal

void adHocToPrincipal(ActionRequestType actionRequested,
                      String annotation,
                      String targetPrincipalId,
                      String responsibilityDescription,
                      boolean forceAction)

adHocToPrincipal

void adHocToPrincipal(ActionRequestType actionRequested,
                      String nodeName,
                      String annotation,
                      String targetPrincipalId,
                      String responsibilityDescription,
                      boolean forceAction)

adHocToPrincipal

void adHocToPrincipal(ActionRequestType actionRequested,
                      String nodeName,
                      String annotation,
                      String targetPrincipalId,
                      String responsibilityDescription,
                      boolean forceAction,
                      String requestLabel)

adHocToPrincipal

void adHocToPrincipal(AdHocToPrincipal adHocToPrincipal,
                      String annotation)

adHocToGroup

void adHocToGroup(ActionRequestType actionRequested,
                  String annotation,
                  String targetGroupId,
                  String responsibilityDescription,
                  boolean forceAction)

adHocToGroup

void adHocToGroup(ActionRequestType actionRequested,
                  String nodeName,
                  String annotation,
                  String targetGroupId,
                  String responsibilityDescription,
                  boolean forceAction)

adHocToGroup

void adHocToGroup(ActionRequestType actionRequested,
                  String nodeName,
                  String annotation,
                  String targetGroupId,
                  String responsibilityDescription,
                  boolean forceAction,
                  String requestLabel)

adHocToGroup

void adHocToGroup(AdHocToGroup adHocToGroup,
                  String annotation)

revokeAdHocRequestById

void revokeAdHocRequestById(String actionRequestId,
                            String annotation)

revokeAdHocRequests

void revokeAdHocRequests(AdHocRevoke revoke,
                         String annotation)

revokeAllAdHocRequests

void revokeAllAdHocRequests(String annotation)

setTitle

void setTitle(String title)

getDocumentTypeName

String getDocumentTypeName()

Specified by:

getDocumentTypeName in interface DocumentContract

isCompletionRequested

boolean isCompletionRequested()

isApprovalRequested

boolean isApprovalRequested()

isAcknowledgeRequested

boolean isAcknowledgeRequested()

isFYIRequested

boolean isFYIRequested()

isBlanketApproveCapable

boolean isBlanketApproveCapable()

isRouteCapable

boolean isRouteCapable()

isValidAction

boolean isValidAction(ActionType actionType)

superUserBlanketApprove

void superUserBlanketApprove(String annotation)

superUserNodeApprove

void superUserNodeApprove(String nodeName,
                          String annotation)

superUserTakeRequestedAction

void superUserTakeRequestedAction(String actionRequestId,
                                  String annotation)

superUserDisapprove

void superUserDisapprove(String annotation)

superUserCancel

void superUserCancel(String annotation)

superUserReturnToPreviousNode

void superUserReturnToPreviousNode(ReturnPoint returnPoint,
                                   String annotation)

complete

void complete(String annotation)

logAnnotation

void logAnnotation(String annotation)

getStatus

DocumentStatus getStatus()

Specified by:

getStatus in interface DocumentContract

checkStatus

boolean checkStatus(DocumentStatus status)

isInitiated

boolean isInitiated()

Indicates if the document is in the initiated state or not.

Returns:

true if in the specified state

isSaved

boolean isSaved()

Indicates if the document is in the saved state or not.

Returns:

true if in the specified state

isEnroute

boolean isEnroute()

Indicates if the document is in the enroute state or not.

Returns:

true if in the specified state

isException

boolean isException()

Indicates if the document is in the exception state or not.

Returns:

true if in the specified state

isCanceled

boolean isCanceled()

Indicates if the document is in the canceled state or not.

Returns:

true if in the specified state

isDisapproved

boolean isDisapproved()

Indicates if the document is in the disapproved state or not.

Returns:

true if in the specified state

isApproved

boolean isApproved()

Indicates if the document is in the Processed or Finalized state.

Returns:

true if in the specified state

isProcessed

boolean isProcessed()

Indicates if the document is in the processed state or not.

Returns:

true if in the specified state

isFinal

boolean isFinal()

Indicates if the document is in the final state or not.

Returns:

true if in the specified state

getPrincipalId

String getPrincipalId()

Returns the principalId with which this WorkflowDocument was constructed

Returns:

the principalId with which this WorkflowDocument was constructed

switchPrincipal

void switchPrincipal(String principalId)

takeGroupAuthority

void takeGroupAuthority(String annotation,
                        String groupId)

releaseGroupAuthority

void releaseGroupAuthority(String annotation,
                           String groupId)

getNodeNames

Set<String> getNodeNames()

Returns the names of the route nodes on the document which are currently active.

If the document has completed it's routing (i.e. it is in processed or final status) then this method may return an empty set since no nodes are active at that time. In order to get either the active *or* terminal nodes, use the getCurrentNodeNames() method.

Returns:

an unmodifiable set containing the names of the active nodes for this document

getCurrentNodeNames

Set<String> getCurrentNodeNames()

Returns the names of the nodes at which the document is currently at in it's route path.

This method differs from getNodeNames() in the fact that if there are no active nodes, it will return the last nodes on the document instead (a.k.a. the document's terminal nodes).

Returns:

an unmodifiable set containing the names of the nodes at which this document is currently located within it's route path

returnToPreviousNode

void returnToPreviousNode(String nodeName,
                          String annotation)

returnToPreviousNode

void returnToPreviousNode(ReturnPoint returnPoint,
                          String annotation)

move

void move(MovePoint movePoint,
          String annotation)

getActiveRouteNodeInstances

List<RouteNodeInstance> getActiveRouteNodeInstances()

getCurrentRouteNodeInstances

List<RouteNodeInstance> getCurrentRouteNodeInstances()

getRouteNodeInstances

List<RouteNodeInstance> getRouteNodeInstances()

getPreviousNodeNames

List<String> getPreviousNodeNames()

getDocumentDetail

DocumentDetail getDocumentDetail()

updateDocumentContent

void updateDocumentContent(DocumentContentUpdate documentContentUpdate)

placeInExceptionRouting

void placeInExceptionRouting(String annotation)

setVariable

void setVariable(String name,
                 String value)

getVariableValue

String getVariableValue(String name)

setReceiveFutureRequests

void setReceiveFutureRequests()

setDoNotReceiveFutureRequests

void setDoNotReceiveFutureRequests()

setClearFutureRequests

void setClearFutureRequests()

getReceiveFutureRequestsValue

String getReceiveFutureRequestsValue()

getDoNotReceiveFutureRequestsValue

String getDoNotReceiveFutureRequestsValue()

getClearFutureRequestsValue

String getClearFutureRequestsValue()