| java.lang.Object
 edu.iu.uis.eden.clientapp.WorkflowDocument
| WorkflowDocument | | public class WorkflowDocument implements java.io.Serializable(Code) | | Represents a document in Workflow from the perspective of the client. This class is one of two
(Java) client interfaces to the KEW system (the other being
WorkflowInfo class). The
first time an instance of this class is created, it will read the client configuration to determine
how to connect to KEW.
This class is used by creating new instances using the appropriate constructor. To create a new
document in KEW, create an instance of this class passing a UserIdVO and a
document type name. To load an existing document, create an instance of this class passing a
UserIdVO and a document ID number.
Internally, this wrapper interacts with the
WorkflowDocumentActions service exported
over the KSB, maintaining state.
This class is not thread safe and must by synchronized externally for concurrent access.
author:
rkirkend
author:
ewestfal |
| Constructor Summary | |
| public | WorkflowDocument(UserIdVO userId, String documentType)
Constructs a WorkflowDocument representing a new document in the workflow system. | | public | WorkflowDocument(UserIdVO userId, Long routeHeaderId)
Loads a workflow document with the given route header ID for the given User. |
| Method Summary | |
| public void | acknowledge(String annotation)
Performs the 'acknowledge' action on the document this WorkflowDocument represents. | | public void | addAttributeDefinition(WorkflowAttributeDefinitionVO attributeDefinition)
Adds an attribute definition which defines creation parameters for a WorkflowAttribute
implementation. | | public void | addSearchableDefinition(WorkflowAttributeDefinitionVO searchableDefinition)
Adds a searchable attribute definition which defines creation parameters for a SearchableAttribute
implementation. | | public void | appSpecificRouteDocumentToUser(String actionRequested, String nodeName, int priority, String annotation, UserIdVO recipient, String responsibilityDesc, boolean ignorePreviousActions)
| | public void | appSpecificRouteDocumentToUser(String actionRequested, String annotation, UserIdVO recipient, String responsibilityDesc, boolean ignorePreviousActions)
Sends an ad hoc request to the specified user at the current active node on the document. | | public void | appSpecificRouteDocumentToUser(String actionRequested, String nodeName, String annotation, UserIdVO recipient, String responsibilityDesc, boolean ignorePreviousActions)
Sends an ad hoc request to the specified user at the specified node on the document. | | public void | appSpecificRouteDocumentToWorkgroup(String actionRequested, String nodeName, int priority, String annotation, WorkgroupIdVO workgroupId, String responsibilityDesc, boolean ignorePreviousActions)
| | public void | appSpecificRouteDocumentToWorkgroup(String actionRequested, String annotation, WorkgroupIdVO workgroupId, String responsibilityDesc, boolean ignorePreviousActions)
Sends an ad hoc request to the specified workgroup at the current active node on the document. | | public void | appSpecificRouteDocumentToWorkgroup(String actionRequested, String nodeName, String annotation, WorkgroupIdVO workgroupId, String responsibilityDesc, boolean ignorePreviousActions)
Sends an ad hoc request to the specified workgroup at the specified node on the document. | | public void | approve(String annotation)
Performs the 'approve' action on the document this WorkflowDocument represents. | | public void | blanketApprove(String annotation)
Performs the 'blanket-approve' action on the document this WorkflowDocument represents. | | public void | blanketApprove(String annotation, String nodeName)
Performs the 'blanketApprove' action on the document this WorkflowDocument represents. | | public void | blanketApprove(String annotation, String[] nodeNames)
Performs the 'blanketApprove' action on the document this WorkflowDocument represents. | | public void | blanketApprove(String annotation, Integer routeLevel)
| | public void | cancel(String annotation)
Performs the 'cancel' action on the document this WorkflowDocument represents. | | public 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. | | public void | clearAttributeDefinitions()
Removes all attribute definitions from the document content. | | public void | clearFYI()
Performs the 'clearFYI' action on the document this WorkflowDocument represents. | | public void | clearSearchableContent()
Clears the searchable content from the document content. | | public void | clearSearchableDefinitions()
Removes all searchable attribute definitions from the document content. | | public void | complete(String annotation)
Performs the 'complete' action on the document this WorkflowDocument represents. | | public void | delete()
Performs the 'delete' action on the document this WorkflowDocument represents. | | public void | deleteNote(NoteVO noteVO)
Deletes a note from the document. | | public void | disapprove(String annotation)
Performs the 'disapprove' action on the document this WorkflowDocument represents. | | public void | fyi()
Performs the 'fyi' action on the document this WorkflowDocument represents. | | public ActionRequestVO[] | getActionRequests()
Returns VOs of the pending ActionRequests on this document. | | public ActionTakenVO[] | getActionsTaken()
Returns VOs of the actions taken on this document. | | public String | getAppDocId()
| | public String | getApplicationContent()
Returns the application specific section of the document content. | | public String | getAttributeContent()
Returns the attribute-generated section of the document content. | | public WorkflowAttributeDefinitionVO[] | getAttributeDefinitions()
Returns the attribute definition VOs currently defined on the document content. | | public Timestamp | getDateCreated()
| | public DocumentDetailVO | getDetail()
Returns a document detail VO representing the route header along with action requests, actions taken,
and route node instances. | | public Integer | getDocRouteLevel()
| | public String | getDocRouteLevelName()
| | public DocumentContentVO | getDocumentContent()
Returns an up-to-date DocumentContent of this document. | | public String | getDocumentType()
| | public String | getInitiatorNetworkId()
| | public String[] | getNodeNames()
Returns names of all active nodes the document is currently at. | | public List<NoteVO> | getNoteList()
| | public String[] | getPreviousNodeNames()
Returns Array of Route Nodes Names that can be safely returned to using the 'returnToPreviousXXX' methods. | | public RouteHeaderVO | getRouteHeader()
| | public Long | getRouteHeaderId()
Returns the id of the workflow document this WorkflowDocument represents. | | public String | getRouteMethodName()
| | public RouteNodeInstanceVO[] | getRouteNodeInstances()
Returns the route node instances that have been created so far during the life of this document. | | public WorkflowAttributeDefinitionVO[] | getSearchableDefinitions()
Returns the searchable attribute definitions on the document content. | | public String | getStatusDisplayValue()
| | public String | getTitle()
| | public UserIdVO | getUserId()
| | public String | getVariable(String name)
Gets the value of a variable on the document, creating the document first if it does not exist. | | public boolean | isAcknowledgeRequested()
Returns whether an acknowledge is requested of the user for this document. | | public boolean | isActionCodeValidForDocument(String actionTakenCode)
| | public boolean | isApprovalRequested()
Returns whether an approval is requested of the user for this document. | | public boolean | isBlanketApproveCapable()
| | public boolean | isCompletionRequested()
Returns whether a completion is requested of the user for this document. | | public boolean | isFYIRequested()
Returns whether an FYI is requested of the user for this document. | | public boolean | isRouteCapable()
Returns whether the user passed into WorkflowDocument at instantiation can route
the document. | | public boolean | isSuperUser()
| | public void | logDocumentAction(String annotation)
Performs the 'logDocumentAction' action on the document this WorkflowDocument represents. | | public void | moveDocument(MovePointVO movePoint, String annotation)
Moves the document from a current node in it's route to another node. | | public void | refreshContent()
Reloads the document route header. | | public void | releaseWorkgroupAuthority(String annotation, WorkgroupIdVO workgroupId)
The user that took the group authority is putting the action items back in the other users action lists. | | public void | removeAttributeDefinition(WorkflowAttributeDefinitionVO attributeDefinition)
Removes an attribute definition from the document content. | | public void | removeSearchableDefinition(WorkflowAttributeDefinitionVO searchableDefinition)
Removes a searchable attribute definition from the document content. | | public void | returnToPreviousNode(String annotation, String nodeName)
Performs the 'returnToPrevious' action on the document this WorkflowDocument represents. | | public void | returnToPreviousNode(String annotation, ReturnPointVO returnPoint)
Performs the 'returnToPrevious' action on the document this WorkflowDocument represents. | | public void | returnToPreviousRouteLevel(String annotation, Integer destRouteLevel)
| | public void | revokeAdHocRequests(AdHocRevokeVO revoke, String annotation)
Revokes AdHoc request(s) according to the given AdHocRevokeVO which is passed in. | | public void | routeDocument(String annotation)
Performs the 'route' action on the document this WorkflowDocument represents. | | public void | saveDocument(String annotation)
Performs the 'save' action on the document this WorkflowDocument represents. | | public DocumentContentVO | saveDocumentContent(DocumentContentVO documentContent)
Saves the given DocumentContentVO for this document. | | public void | saveRoutingData()
Commits any changes made to the local copy of this document to the workflow system. | | public void | setAppDocId(String appDocId)
| | public void | setApplicationContent(String applicationContent)
Sets the application specific section of the document content. | | public void | setTitle(String title)
Sets the title of the document, empty string if null is specified. | | public void | setUserId(UserIdVO userId)
| | public void | setVariable(String name, String value)
Sets a variable on the document. | | public boolean | stateIsApproved()
Indicates if the document is in the approved state or not. | | public boolean | stateIsCanceled()
Indicates if the document is in the canceled state or not. | | public boolean | stateIsDisapproved()
Indicates if the document is in the disapproved state or not. | | public boolean | stateIsEnroute()
Indicates if the document is in the enroute state or not. | | public boolean | stateIsException()
Indicates if the document is in the exception state or not. | | public boolean | stateIsFinal()
Indicates if the document is in the final state or not. | | public boolean | stateIsInitiated()
Indicates if the document is in the initiated state or not. | | public boolean | stateIsProcessed()
Indicates if the document is in the processed state or not. | | public boolean | stateIsSaved()
Indicates if the document is in the saved state or not. | | public void | superUserActionRequestApprove(Long actionRequestId, String annotation)
| | public void | superUserApprove(String annotation)
Performs the 'super-user-approve' action on the document this WorkflowDocument represents. | | public void | superUserCancel(String annotation)
Performs the 'super-user-cancel' action on the document this WorkflowDocument represents. | | public void | superUserDisapprove(String annotation)
Performs the 'super-user-disapprove' action on the document this WorkflowDocument represents. | | public void | takeWorkgroupAuthority(String annotation, WorkgroupIdVO workgroupId)
The user taking action removes the action items for this workgroup and document from all other
group members' action lists. | | public void | updateNote(NoteVO noteVO)
Updates the note of the same note id, on the document. | | public WorkflowAttributeValidationErrorVO[] | validateAttributeDefinition(WorkflowAttributeDefinitionVO attributeDefinition)
Validate the WorkflowAttributeDefinition against it's attribute on the server. |
| WorkflowDocument | | public WorkflowDocument(UserIdVO userId, String documentType) throws WorkflowException(Code) | | Constructs a WorkflowDocument representing a new document in the workflow system.
Creation/committing of the new document is deferred until the first action is
taken on the document.
Parameters:
userId - the user as which to take actions on the document
Parameters:
documentType - the type of the document to create
throws:
WorkflowException - if anything goes awry |
| WorkflowDocument | | public WorkflowDocument(UserIdVO userId, Long routeHeaderId) throws WorkflowException(Code) | | Loads a workflow document with the given route header ID for the given User. If no document
can be found with the given ID, then the
getRouteHeader() method of the WorkflowDocument
which is created will return null.
throws:
WorkflowException - if there is a problem loading the WorkflowDocument |
| addAttributeDefinition | | public void addAttributeDefinition(WorkflowAttributeDefinitionVO attributeDefinition)(Code) | | 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.
This is a convenience method that delegates to the
DocumentContentVO .
See Also: DocumentContentVO.addAttributeDefinition(WorkflowAttributeDefinitionVO) |
| addSearchableDefinition | | public void addSearchableDefinition(WorkflowAttributeDefinitionVO searchableDefinition)(Code) | | 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. This is
a convenience method that delegates to the
DocumentContentVO .
|
| appSpecificRouteDocumentToUser | | public void appSpecificRouteDocumentToUser(String actionRequested, String nodeName, int priority, String annotation, UserIdVO recipient, String responsibilityDesc, boolean ignorePreviousActions) throws WorkflowException(Code) | | WorkflowDocument.appSpecificRouteDocumentToUser(String,String,String,UserIdVO,String,boolean) |
| appSpecificRouteDocumentToUser | | public void appSpecificRouteDocumentToUser(String actionRequested, String annotation, UserIdVO recipient, String responsibilityDesc, boolean ignorePreviousActions) throws WorkflowException(Code) | | Sends an ad hoc request to the specified user at the current active node on the document. If the document is
in a terminal state, the request will be attached to the terminal node.
See Also: WorkflowDocument.appSpecificRouteDocumentToUser(String,String,String,UserIdVO,String,boolean)
See Also: WorkflowDocumentActions.appSpecificRouteDocument(UserIdVORouteHeaderVOStringStringStringResponsiblePartyVOStringboolean) |
| appSpecificRouteDocumentToUser | | public void appSpecificRouteDocumentToUser(String actionRequested, String nodeName, String annotation, UserIdVO recipient, String responsibilityDesc, boolean ignorePreviousActions) throws WorkflowException(Code) | | Sends an ad hoc request to the specified user at the specified node on the document. If the document is
in a terminal state, the request will be attached to the terminal node.
See Also: WorkflowDocument.appSpecificRouteDocumentToUser(String,String,UserIdVO,String,boolean)
See Also: WorkflowDocumentActions.appSpecificRouteDocument(UserIdVORouteHeaderVOStringStringStringResponsiblePartyVOStringboolean) |
| appSpecificRouteDocumentToWorkgroup | | public void appSpecificRouteDocumentToWorkgroup(String actionRequested, String nodeName, int priority, String annotation, WorkgroupIdVO workgroupId, String responsibilityDesc, boolean ignorePreviousActions) throws WorkflowException(Code) | | WorkflowDocument.appSpecificRouteDocumentToWorkgroup(String,String,String,WorkgroupIdVO,String,boolean) |
| appSpecificRouteDocumentToWorkgroup | | public void appSpecificRouteDocumentToWorkgroup(String actionRequested, String annotation, WorkgroupIdVO workgroupId, String responsibilityDesc, boolean ignorePreviousActions) throws WorkflowException(Code) | | Sends an ad hoc request to the specified workgroup at the current active node on the document. If the document is
in a terminal state, the request will be attached to the terminal node.
See Also: WorkflowDocument.appSpecificRouteDocumentToWorkgroup(String,String,String,WorkgroupIdVO,String,boolean)
See Also: WorkflowDocumentActions.appSpecificRouteDocument(UserIdVORouteHeaderVOStringStringStringResponsiblePartyVOStringboolean) |
| appSpecificRouteDocumentToWorkgroup | | public void appSpecificRouteDocumentToWorkgroup(String actionRequested, String nodeName, String annotation, WorkgroupIdVO workgroupId, String responsibilityDesc, boolean ignorePreviousActions) throws WorkflowException(Code) | | Sends an ad hoc request to the specified workgroup at the specified node on the document. If the document is
in a terminal state, the request will be attached to the terminal node.
See Also: WorkflowDocument.appSpecificRouteDocumentToWorkgroup(String,String,String,WorkgroupIdVO,String,boolean)
See Also: WorkflowDocumentActions.appSpecificRouteDocument(UserIdVORouteHeaderVOStringStringStringResponsiblePartyVOStringboolean) |
| clearAttributeContent | | public void clearAttributeContent()(Code) | | 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.
This is a convenience method that delegates to the
DocumentContentVO .
In order for these changes to take effect, an action must be performed on the document (such as "save").
|
| clearAttributeDefinitions | | public void clearAttributeDefinitions()(Code) | | Removes all attribute definitions from the document content. This is
a convenience method that delegates to the
DocumentContentVO .
|
| clearSearchableContent | | public void clearSearchableContent()(Code) | | Clears the searchable content from the document content. This is
a convenience method that delegates to the
DocumentContentVO .
|
| clearSearchableDefinitions | | public void clearSearchableDefinitions()(Code) | | Removes all searchable attribute definitions from the document content. This is
a convenience method that delegates to the
DocumentContentVO .
|
| deleteNote | | public void deleteNote(NoteVO noteVO)(Code) | | Deletes a note from the document. The deletion is deferred until the next time the document is committed (via an action).
Parameters:
noteVO - the note to remove from the document |
| fyi | | public void fyi() throws WorkflowException(Code) | | Performs the 'fyi' 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
throws:
WorkflowException - in case an error occurs fyi-ing the document |
| getActionRequests | | public ActionRequestVO[] getActionRequests() throws WorkflowException(Code) | | Returns VOs of the pending ActionRequests on this document. If this object represents a new document
that has not yet been created, then an empty array will be returned. The ordering of ActionRequests
returned by this method is not guaranteed.
This method relies on the WorkflowUtility service
VOs of the pending ActionRequests on this document
throws:
WorkflowException - if an error occurs obtaining the pending action requests for this document
See Also: WorkflowUtility.getActionRequests(Long) |
| getActionsTaken | | public ActionTakenVO[] getActionsTaken() throws WorkflowException(Code) | | Returns VOs of the actions taken on this document. If this object represents a new document
that has not yet been created, then an empty array will be returned. The ordering of actions taken
returned by this method is not guaranteed.
This method relies on the WorkflowUtility service
VOs of the actions that have been taken on this document
throws:
WorkflowException - if an error occurs obtaining the actions taken on this document
See Also: WorkflowUtility.getActionsTaken(Long) |
| getAppDocId | | public String getAppDocId()(Code) | | Returns the "application doc id" set on this workflow document (if any)
the "application doc id" set on this workflow document (if any) |
| getApplicationContent | | public String getApplicationContent()(Code) | | Returns the application specific section of the document content. This is
a convenience method that delegates to the
DocumentContentVO .
For documents routed prior to Workflow 2.0:
If the application did NOT use attributes for XML generation, this method will
return the entire document content XML. Otherwise it will return the empty string.
See Also: DocumentContentVO.getApplicationContent |
| getDateCreated | | public Timestamp getDateCreated()(Code) | | Returns the date/time the document was created, or null if the document has not yet been created
the date/time the document was created, or null if the document has not yet been created |
| getDetail | | public DocumentDetailVO getDetail() throws WorkflowException(Code) | | Returns a document detail VO representing the route header along with action requests, actions taken,
and route node instances.
Returns a document detail VO representing the route header along with action requests, actions taken, and route node instances.
throws:
WorkflowException - |
| getDocRouteLevelName | | public String getDocRouteLevelName() throws WorkflowException(Code) | | TODO this method still needs to be updated to work properly for Workflow 2.1
it would probably be easier to just put this info on bean from the server
|
| getInitiatorNetworkId | | public String getInitiatorNetworkId()(Code) | | |
| getNoteList | | public List<NoteVO> getNoteList()(Code) | | Returns a list of NoteVO representing the notes on the document
a list of NoteVO representing the notes on the document
See Also: RouteHeaderVO.getNotes |
| getPreviousNodeNames | | public String[] getPreviousNodeNames() throws WorkflowException(Code) | | Returns Array of Route Nodes Names that can be safely returned to using the 'returnToPreviousXXX' methods.
Names are sorted in reverse chronological order.
array of Route Nodes Names that can be safely returned to using the 'returnToPreviousXXX' methods
throws:
WorkflowException - if an error occurs obtaining the names of the previous route nodes for this document
See Also: WorkflowUtility.getPreviousRouteNodeNames(Long) |
| getRouteHeader | | public RouteHeaderVO getRouteHeader()(Code) | | Returns the RouteHeaderVO for the workflow document this WorkflowDocument represents
|
| getRouteHeaderId | | public Long getRouteHeaderId() throws WorkflowException(Code) | | Returns the id of the workflow document this WorkflowDocument represents. If this is a new document
that has not yet been created, the document is first created (and therefore this will return a new id)
the id of the workflow document this WorkflowDocument represents
throws:
WorkflowException - if an error occurs during document creation |
| getRouteMethodName | | public String getRouteMethodName() throws WorkflowException(Code) | | TODO this method still needs to be updated to work properly for Workflow 2.1
it would probably be easier to just put this info on bean from the server
|
| getStatusDisplayValue | | public String getStatusDisplayValue()(Code) | | Returns the display value of the current document status
the display value of the current document status |
| getTitle | | public String getTitle()(Code) | | Returns the title of the document
the title of the document |
| getUserId | | public UserIdVO getUserId()(Code) | | Returns the userId with which this WorkflowDocument was constructed
the userId with which this WorkflowDocument was constructed |
| getVariable | | public String getVariable(String name) throws WorkflowException(Code) | | Gets the value of a variable on the document, creating the document first if it does not exist.
Parameters:
name - variable name variable value |
| isAcknowledgeRequested | | public boolean isAcknowledgeRequested()(Code) | | Returns whether an acknowledge is requested of the user for this document. This is
a convenience method that delegates to
RouteHeaderVO.isAckRequested .
whether an acknowledge is requested of the user for this document
See Also: RouteHeaderVO.isAckRequested |
| isActionCodeValidForDocument | | public boolean isActionCodeValidForDocument(String actionTakenCode)(Code) | | Returns whether the specified action code is valid for the current user and document
whether the user can blanket approve the document
See Also: RouteHeaderVO.getValidActions |
| isBlanketApproveCapable | | public boolean isBlanketApproveCapable()(Code) | | Returns whether the user can blanket approve the document
whether the user can blanket approve the document
See Also: RouteHeaderVO.getValidActions |
| isRouteCapable | | public boolean isRouteCapable()(Code) | | Returns whether the user passed into WorkflowDocument at instantiation can route
the document.
if user passed into WorkflowDocument at instantiation can routethe document. |
| refreshContent | | public void refreshContent() throws WorkflowException(Code) | | Reloads the document route header. If this is a new document, the document is created first.
Next time document content is accessed, an up-to-date copy will be retrieved from workflow.
throws:
WorkflowException - in case an error occurs retrieving the route header |
| releaseWorkgroupAuthority | | public void releaseWorkgroupAuthority(String annotation, WorkgroupIdVO workgroupId) throws WorkflowException(Code) | | The user that took the group authority is putting the action items back in the other users action lists.
If this is a new document, the document is created first.
Parameters:
annotation - the message to log for the action
Parameters:
workgroupId - the workgroup on which to take authority
throws:
WorkflowException - user taking action is not in workgroup or did not take workgroup authority |
| removeAttributeDefinition | | public void removeAttributeDefinition(WorkflowAttributeDefinitionVO attributeDefinition)(Code) | | Removes an attribute definition from the document content. This is
a convenience method that delegates to the
DocumentContentVO .
Parameters:
attributeDefinition - the attribute definition VO to remove |
| removeSearchableDefinition | | public void removeSearchableDefinition(WorkflowAttributeDefinitionVO searchableDefinition)(Code) | | Removes a searchable attribute definition from the document content. This is
a convenience method that delegates to the
DocumentContentVO .
Parameters:
searchableDefinition - the searchable attribute definition to remove |
| setAppDocId | | public void setAppDocId(String appDocId)(Code) | | Sets the "application doc id" on the document
Parameters:
appDocId - the "application doc id" to set on the workflow document |
| setApplicationContent | | public void setApplicationContent(String applicationContent)(Code) | | Sets the application specific section of the document content. This is
a convenience method that delegates to the
DocumentContentVO .
|
| setTitle | | public void setTitle(String title) throws WorkflowException(Code) | | Sets the title of the document, empty string if null is specified.
Parameters:
title - title of the document to set, or null |
| setUserId | | public void setUserId(UserIdVO userId)(Code) | | Sets the userId under which actions against this document should be taken
Parameters:
userId - userId under which actions against this document should be taken |
| setVariable | | public void setVariable(String name, String value) throws WorkflowException(Code) | | Sets a variable on the document. The assignment is deferred until the next time the document is committed (via an action).
Parameters:
name - name of the variable
Parameters:
value - value of the variable |
| stateIsApproved | | public boolean stateIsApproved()(Code) | | Indicates if the document is in the approved state or not. Will answer true is document is in Processed or Finalized state.
true if in the specified state |
| stateIsCanceled | | public boolean stateIsCanceled()(Code) | | Indicates if the document is in the canceled state or not.
true if in the specified state |
| stateIsDisapproved | | public boolean stateIsDisapproved()(Code) | | Indicates if the document is in the disapproved state or not.
true if in the specified state |
| stateIsEnroute | | public boolean stateIsEnroute()(Code) | | Indicates if the document is in the enroute state or not.
true if in the specified state |
| stateIsException | | public boolean stateIsException()(Code) | | Indicates if the document is in the exception state or not.
true if in the specified state |
| stateIsFinal | | public boolean stateIsFinal()(Code) | | Indicates if the document is in the final state or not.
true if in the specified state |
| stateIsInitiated | | public boolean stateIsInitiated()(Code) | | Indicates if the document is in the initiated state or not.
true if in the specified state |
| stateIsProcessed | | public boolean stateIsProcessed()(Code) | | Indicates if the document is in the processed state or not.
true if in the specified state |
| stateIsSaved | | public boolean stateIsSaved()(Code) | | Indicates if the document is in the saved state or not.
true if in the specified state |
| updateNote | | public void updateNote(NoteVO noteVO)(Code) | | Updates the note of the same note id, on the document. The update is deferred until the next time the document is committed (via an action).
Parameters:
noteVO - the note to update |
|
|