org.kuali.rice.kns.workflow.service
Interface KualiWorkflowDocument

All Known Implementing Classes:

KualiWorkflowDocumentImpl

public interface KualiWorkflowDocument

Method Summary

void	acknowledge(String annotation)
void	addAttributeDefinition(org.kuali.rice.kew.dto.WorkflowAttributeDefinitionDTO attributeDefinition) Adds an attribute definition which defines creation parameters for a WorkflowAttribute implementation.
void	addSearchableDefinition(org.kuali.rice.kew.dto.WorkflowAttributeDefinitionDTO searchableDefinition) Adds a searchable attribute definition which defines creation parameters for a SearchableAttribute implementation.
void	adHocRouteDocumentToGroup(String actionRequested, String routeTypeName, String annotation, String groupId, String responsibilityDesc, boolean forceAction)
void	adHocRouteDocumentToGroup(String actionRequested, String routeTypeName, String annotation, String groupId, String responsibilityDesc, boolean forceAction, String actionRequestLabel)
void	adHocRouteDocumentToPrincipal(String actionRequested, String routeTypeName, String annotation, String principalId, String responsibilityDesc, boolean forceAction)
void	adHocRouteDocumentToPrincipal(String actionRequested, String routeTypeName, String annotation, String principalId, String responsibilityDesc, boolean forceAction, String actionRequestLabel)
void	approve(String annotation)
void	blanketApprove(String annotation)
void	blanketApprove(String annotation, Integer routeLevel)
void	cancel(String annotation)
void	clearAttributeContent() Clears all attribute document content from the document.
void	clearAttributeDefinitions()
void	clearSearchableDefinitions()
void	complete(String annotation)
void	delete()
void	disapprove(String annotation)
void	fyi()
Set<org.kuali.rice.kim.bo.Person>	getAllPriorApprovers() This method returns a set of all approvers of this document.
String	getAppDocId()
String	getApplicationContent()
String	getAttributeContent() Returns the attribute-generated document content.
org.kuali.rice.kew.dto.WorkflowAttributeDefinitionDTO[]	getAttributeDefinitions()
Timestamp	getCreateDate()
String	getCurrentRouteNodeNames() Returns the current node names of the document delimited by the constant: DocumentRouteHeaderValue.CURRENT_ROUTE_NODE_NAME_DELIMITER
Integer	getDocRouteLevel()
String	getDocumentType()
String	getInitiatorNetworkId() Deprecated. use getInitiatorPrincipalId instead, invocation of this method forces a lookup of the principal name which may be inefficient
String	getInitiatorPrincipalId()
String[]	getNodeNames() Returns the names of the nodes that the document is currently at.
String	getRoutedByPrincipalId()
String	getRoutedByUserNetworkId() Deprecated. use getRoutedByPrincipalId instead, invocation of this method forces a lookup of the principal name which may be inefficient
org.kuali.rice.kew.dto.RouteHeaderDTO	getRouteHeader()
Long	getRouteHeaderId()
org.kuali.rice.kew.dto.WorkflowAttributeDefinitionDTO[]	getSearchableDefinitions()
String	getStatusDisplayValue()
String	getTitle()
boolean	isAcknowledgeRequested() Returns true if the user currently has this document in their Action List with an Acknowledge Request.
boolean	isAdHocRequested() This method determines whether workflowDocument.getUserId() currently has an ad hoc request is his/her action list
boolean	isApprovalRequested() Returns true if the user currently has this document in their Action List with an Approval Request.
boolean	isBlanketApproveCapable() Returns true if the user is authorized to Blanket Approve this document.
boolean	isCompletionRequested() Returns true if the user currently has this document in their Action List with an Completion Request.
boolean	isFYIRequested() Returns true if the user currently has this document in their Action List with an FYI.
boolean	isStandardSaveAllowed() Checks to see if this document is allowed to have a standard 'save' performed
void	logDocumentAction(String annotation)
void	refreshContent()
void	removeAttributeDefinition(org.kuali.rice.kew.dto.WorkflowAttributeDefinitionDTO attributeDefinition)
void	removeSearchableDefinition(org.kuali.rice.kew.dto.WorkflowAttributeDefinitionDTO searchableDefinition)
void	returnToPreviousNode(String annotation, org.kuali.rice.kew.dto.ReturnPointDTO returnPoint) Performs the 'returnToPrevious' action on the document this WorkflowDocument represents.
void	returnToPreviousNode(String annotation, String nodeName) Performs the 'returnToPrevious' action on the document this WorkflowDocument represents.
void	returnToPreviousRouteLevel(String annotation, Integer destRouteLevel)
void	routeDocument(String annotation)
void	saveDocument(String annotation)
void	saveRoutingData()
void	setAppDocId(String appDocId)
void	setApplicationContent(String applicationContent) Sets the application specific document content.
void	setClearFutureRequests()
void	setDoNotReceiveFutureRequests()
void	setReceiveFutureRequests()
void	setTitle(String title)
boolean	stateIsApproved() Indicates if the document is in the approved state or not.
boolean	stateIsCanceled() Indicates if the document is in the canceled state or not.
boolean	stateIsDisapproved() Indicates if the document is in the disapproved state or not.
boolean	stateIsEnroute() Indicates if the document is in the enroute state or not.
boolean	stateIsException() Indicates if the document is in the exception state or not.
boolean	stateIsFinal() Indicates if the document is in the final state or not.
boolean	stateIsInitiated() Indicates if the document is in the initated state or not.
boolean	stateIsProcessed() Indicates if the document is in the processed state or not.
boolean	stateIsSaved() Indicates if the document is in the saved state or not.
void	superUserActionRequestApprove(Long actionRequestId, String annotation)
void	superUserApprove(String annotation)
void	superUserCancel(String annotation)
void	superUserDisapprove(String annotation)
boolean	userIsInitiator(org.kuali.rice.kim.bo.Person user) Returns true if the principalName of the given KualiUser matches the initiatorNetworkId of this document
boolean	userIsRoutedByUser(org.kuali.rice.kim.bo.Person user) Returns true if the principalName of the given KualiUser matches the routedByUserNetworkId of this document

Method Detail

getApplicationContent

String getApplicationContent()

setApplicationContent

void setApplicationContent(String applicationContent)

Sets the application specific document content.

clearAttributeContent

void clearAttributeContent()

Clears all attribute document content from the document. Typically, this will be used if it is necessary to update the attribute doc content on the document. This can be accomplished by clearing the content and then adding the desired attribute definitions. In order for these changes to take effect, an action must be performed on the document (such as "save").

getAttributeContent

String getAttributeContent()

Returns the attribute-generated document content.

addAttributeDefinition

void addAttributeDefinition(org.kuali.rice.kew.dto.WorkflowAttributeDefinitionDTO attributeDefinition)

Adds an attribute definition which defines creation parameters for a WorkflowAttribute implementation. The created attribute will be used to generate attribute document content. When the document is sent to the server, this will be appended to the existing attribute doc content. If it is required to replace the attribute document content, then the clearAttributeContent() method should be invoked prior to adding attribute definitions.

removeAttributeDefinition

void removeAttributeDefinition(org.kuali.rice.kew.dto.WorkflowAttributeDefinitionDTO attributeDefinition)

clearAttributeDefinitions

void clearAttributeDefinitions()

getAttributeDefinitions

org.kuali.rice.kew.dto.WorkflowAttributeDefinitionDTO[] getAttributeDefinitions()

addSearchableDefinition

void addSearchableDefinition(org.kuali.rice.kew.dto.WorkflowAttributeDefinitionDTO searchableDefinition)

Adds a searchable attribute definition which defines creation parameters for a SearchableAttribute implementation. The created attribute will be used to generate searchable document content. When the document is sent to the server, this will be appended to the existing searchable doc content. If it is required to replace the searchable document content, then the clearSearchableContent() method should be invoked prior to adding definitions.

removeSearchableDefinition

void removeSearchableDefinition(org.kuali.rice.kew.dto.WorkflowAttributeDefinitionDTO searchableDefinition)

clearSearchableDefinitions

void clearSearchableDefinitions()

getSearchableDefinitions

org.kuali.rice.kew.dto.WorkflowAttributeDefinitionDTO[] getSearchableDefinitions()

getRouteHeader

org.kuali.rice.kew.dto.RouteHeaderDTO getRouteHeader()

getRouteHeaderId

Long getRouteHeaderId()
                      throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

setAppDocId

void setAppDocId(String appDocId)

getAppDocId

String getAppDocId()

getInitiatorNetworkId

String getInitiatorNetworkId()

Deprecated. use getInitiatorPrincipalId instead, invocation of this method forces a lookup of the principal name which may be inefficient

getRoutedByUserNetworkId

String getRoutedByUserNetworkId()

Deprecated. use getRoutedByPrincipalId instead, invocation of this method forces a lookup of the principal name which may be inefficient

getInitiatorPrincipalId

String getInitiatorPrincipalId()

getRoutedByPrincipalId

String getRoutedByPrincipalId()

getTitle

String getTitle()

saveDocument

void saveDocument(String annotation)
                  throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

routeDocument

void routeDocument(String annotation)
                   throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

disapprove

void disapprove(String annotation)
                throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

approve

void approve(String annotation)
             throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

superUserApprove

void superUserApprove(String annotation)
                      throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

superUserActionRequestApprove

void superUserActionRequestApprove(Long actionRequestId,
                                   String annotation)
                                   throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

superUserCancel

void superUserCancel(String annotation)
                     throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

superUserDisapprove

void superUserDisapprove(String annotation)
                         throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

cancel

void cancel(String annotation)
            throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

blanketApprove

void blanketApprove(String annotation)
                    throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

blanketApprove

void blanketApprove(String annotation,
                    Integer routeLevel)
                    throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

saveRoutingData

void saveRoutingData()
                     throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

acknowledge

void acknowledge(String annotation)
                 throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

fyi

void fyi()
         throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

delete

void delete()
            throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

refreshContent

void refreshContent()
                    throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

adHocRouteDocumentToPrincipal

void adHocRouteDocumentToPrincipal(String actionRequested,
                                   String routeTypeName,
                                   String annotation,
                                   String principalId,
                                   String responsibilityDesc,
                                   boolean forceAction)
                                   throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

adHocRouteDocumentToGroup

void adHocRouteDocumentToGroup(String actionRequested,
                               String routeTypeName,
                               String annotation,
                               String groupId,
                               String responsibilityDesc,
                               boolean forceAction)
                               throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

adHocRouteDocumentToPrincipal

void adHocRouteDocumentToPrincipal(String actionRequested,
                                   String routeTypeName,
                                   String annotation,
                                   String principalId,
                                   String responsibilityDesc,
                                   boolean forceAction,
                                   String actionRequestLabel)
                                   throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

adHocRouteDocumentToGroup

void adHocRouteDocumentToGroup(String actionRequested,
                               String routeTypeName,
                               String annotation,
                               String groupId,
                               String responsibilityDesc,
                               boolean forceAction,
                               String actionRequestLabel)
                               throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

setTitle

void setTitle(String title)
              throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

getDocumentType

String getDocumentType()

isAdHocRequested

boolean isAdHocRequested()

This method determines whether workflowDocument.getUserId() currently has an ad hoc request is his/her action list

Returns:

boolean indicating whether there is an active ad hoc request for this user

isAcknowledgeRequested

boolean isAcknowledgeRequested()

Returns true if the user currently has this document in their Action List with an Acknowledge Request. The user in this case is whatever user was passed in when the document was loaded. This is typically the current webapp user.

Returns:

true if the user has the document in their Action List waiting for an Acknowledgement, false otherwise.

isApprovalRequested

boolean isApprovalRequested()

Returns true if the user currently has this document in their Action List with an Approval Request. The user in this case is whatever user was passed in when the document was loaded. This is typically the current webapp user.

Returns:

true if the user has the document in their Action List waiting for an Approval, false otherwise.

isCompletionRequested

boolean isCompletionRequested()

Returns true if the user currently has this document in their Action List with an Completion Request. The user in this case is whatever user was passed in when the document was loaded. This is typically the current webapp user.

Returns:

true if the user has the document in their Action List waiting for a Completion, false otherwise.

isFYIRequested

boolean isFYIRequested()

Returns true if the user currently has this document in their Action List with an FYI. The user in this case is whatever user was passed in when the document was loaded. This is typically the current webapp user.

Returns:

true if the user has the document in their Action List waiting for an FYI, false otherwise.

isBlanketApproveCapable

boolean isBlanketApproveCapable()

Returns true if the user is authorized to Blanket Approve this document. The user in this case is whatever user was passed in when the document was loaded. This is typically the current webapp user.

Returns:

true if the user is authorized to Blanket Approve this document, false otherwise.

isStandardSaveAllowed

boolean isStandardSaveAllowed()

Checks to see if this document is allowed to have a standard 'save' performed

Returns:

true if the saveDocument() method is valid to be called.... false otherwise

getDocRouteLevel

Integer getDocRouteLevel()

complete

void complete(String annotation)
              throws org.kuali.rice.kew.exception.WorkflowException

Parameters:

annotation -

Throws:

org.kuali.rice.kew.exception.InvalidActionTakenException

org.kuali.rice.kew.exception.ResourceUnavailableException

org.kuali.rice.kew.exception.WorkflowException

returnToPreviousNode

void returnToPreviousNode(String annotation,
                          String nodeName)
                          throws org.kuali.rice.kew.exception.WorkflowException

Performs the 'returnToPrevious' action on the document this WorkflowDocument represents. If this is a new document, the document is created first.

Parameters:

annotation - the message to log for the action

nodeName - the node to return to

Throws:

org.kuali.rice.kew.exception.WorkflowException - in case an error occurs returning to previous node

See Also:

WorkflowDocumentActions#returnDocumentToPreviousNode(UserIdDTO, RouteHeaderDTO, ReturnPointDTO, String)

returnToPreviousNode

void returnToPreviousNode(String annotation,
                          org.kuali.rice.kew.dto.ReturnPointDTO returnPoint)
                          throws org.kuali.rice.kew.exception.WorkflowException

Performs the 'returnToPrevious' action on the document this WorkflowDocument represents. If this is a new document, the document is created first.

Parameters:

annotation - the message to log for the action

ReturnPointDTO - the node to return to

Throws:

org.kuali.rice.kew.exception.WorkflowException - in case an error occurs returning to previous node

See Also:

WorkflowDocumentActions#returnDocumentToPreviousNode(UserIdDTO, RouteHeaderDTO, ReturnPointDTO, String)

returnToPreviousRouteLevel

void returnToPreviousRouteLevel(String annotation,
                                Integer destRouteLevel)
                                throws org.kuali.rice.kew.exception.WorkflowException

Parameters:

annotation -

destRouteLevel -

Throws:

org.kuali.rice.kew.exception.WorkflowException

org.kuali.rice.kew.exception.InvalidActionTakenException

org.kuali.rice.kew.exception.ResourceUnavailableException

logDocumentAction

void logDocumentAction(String annotation)
                       throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

stateIsInitiated

boolean stateIsInitiated()

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

Returns:

true if in the specified state

stateIsSaved

boolean stateIsSaved()

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

Returns:

true if in the specified state

stateIsEnroute

boolean stateIsEnroute()

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

Returns:

true if in the specified state

stateIsFinal

boolean stateIsFinal()

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

Returns:

true if in the specified state

stateIsException

boolean stateIsException()

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

Returns:

true if in the specified state

stateIsCanceled

boolean stateIsCanceled()

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

Returns:

true if in the specified state

stateIsDisapproved

boolean stateIsDisapproved()

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

Returns:

true if in the specified state

stateIsApproved

boolean stateIsApproved()

Indicates if the document is in the approved state or not. Will answer true is document is in Processed or Finalized state.

Returns:

true if in the specified state

stateIsProcessed

boolean stateIsProcessed()

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

Returns:

true if in the specified state

getStatusDisplayValue

String getStatusDisplayValue()

getCreateDate

Timestamp getCreateDate()

userIsInitiator

boolean userIsInitiator(org.kuali.rice.kim.bo.Person user)

Returns true if the principalName of the given KualiUser matches the initiatorNetworkId of this document

Parameters:

user -

Returns:

true if the given user is the initiator of this document

userIsRoutedByUser

boolean userIsRoutedByUser(org.kuali.rice.kim.bo.Person user)

Returns true if the principalName of the given KualiUser matches the routedByUserNetworkId of this document

Parameters:

user -

Returns:

true if the given user is the user who routed this document

getNodeNames

String[] getNodeNames()
                      throws org.kuali.rice.kew.exception.WorkflowException

Returns the names of the nodes that the document is currently at.

Throws:

org.kuali.rice.kew.exception.WorkflowException

getCurrentRouteNodeNames

String getCurrentRouteNodeNames()

Returns the current node names of the document delimited by the constant: DocumentRouteHeaderValue.CURRENT_ROUTE_NODE_NAME_DELIMITER

getAllPriorApprovers

Set<org.kuali.rice.kim.bo.Person> getAllPriorApprovers()
                                                       throws org.kuali.rice.kew.exception.WorkflowException

This method returns a set of all approvers of this document.

Returns:

a set of all approvers

Throws:

org.kuali.rice.kew.exception.WorkflowException

setReceiveFutureRequests

void setReceiveFutureRequests()
                              throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

setDoNotReceiveFutureRequests

void setDoNotReceiveFutureRequests()
                                   throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

setClearFutureRequests

void setClearFutureRequests()
                            throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException