Java Doc for KualiWorkflowDocument.java in  » ERP-CRM-Financial » Kuali-Financial-System » org » kuali » core » workflow » service » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » ERP CRM Financial » Kuali Financial System » org.kuali.core.workflow.service 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.kuali.core.workflow.service.KualiWorkflowDocument

All known Subclasses:   org.kuali.core.workflow.service.impl.KualiWorkflowDocumentImpl,  org.kuali.workflow.MockWorkflowDocument,  org.kuali.core.impls.MockWorkflowDocument,
KualiWorkflowDocument
public interface KualiWorkflowDocument (Code)




Method Summary
abstract public  voidacknowledge(String annotation)
    
abstract public  voidaddAttributeDefinition(WorkflowAttributeDefinitionVO attributeDefinition)
     Adds an attribute definition which defines creation parameters for a WorkflowAttribute implementation.
abstract public  voidaddSearchableDefinition(WorkflowAttributeDefinitionVO searchableDefinition)
     Adds a searchable attribute definition which defines creation parameters for a SearchableAttribute implementation.
abstract public  voidappSpecificRouteDocumentToUser(String actionRequested, String routeTypeName, int priority, String annotation, UserIdVO recipient, String responsibilityDesc, boolean ignorePreviousActions)
    
abstract public  voidappSpecificRouteDocumentToWorkgroup(String actionRequested, String routeTypeName, int priority, String annotation, WorkgroupIdVO workgroupId, String responsibilityDesc, boolean ignorePreviousActions)
    
abstract public  voidapprove(String annotation)
    
abstract public  voidblanketApprove(String annotation)
    
abstract public  voidblanketApprove(String annotation, Integer routeLevel)
    
abstract public  voidcancel(String annotation)
    
abstract public  voidclearAttributeContent()
     Clears all attribute document content from the document.
abstract public  voidclearAttributeDefinitions()
    
abstract public  voidclearSearchableDefinitions()
    
abstract public  voidcomplete(String annotation)
    
abstract public  voiddelete()
    
abstract public  voiddisapprove(String annotation)
    
abstract public  voidfyi()
    
abstract public  StringgetAppDocId()
    
abstract public  StringgetApplicationContent()
    
abstract public  StringgetAttributeContent()
     Returns the attribute-generated document content.
abstract public  WorkflowAttributeDefinitionVO[]getAttributeDefinitions()
    
abstract public  TimestampgetCreateDate()
    
public  StringgetCurrentRouteNodeNames()
    
abstract public  IntegergetDocRouteLevel()
    
abstract public  StringgetDocRouteLevelName()
    
abstract public  StringgetDocumentType()
    
abstract public  StringgetInitiatorNetworkId()
    
public  String[]getNodeNames()
     Returns the names of the nodes that the document is currently at.
abstract public  RouteHeaderVOgetRouteHeader()
    
abstract public  LonggetRouteHeaderId()
    
abstract public  StringgetRouteTypeName()
    
abstract public  StringgetRoutedByUserNetworkId()
    
abstract public  WorkflowAttributeDefinitionVO[]getSearchableDefinitions()
    
abstract public  StringgetStatusDisplayValue()
    
abstract public  StringgetTitle()
    
abstract public  booleanisAcknowledgeRequested()
     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.
public  booleanisAdHocRequested()
    
abstract public  booleanisApprovalRequested()
     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.
abstract public  booleanisBlanketApproveCapable()
     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.
abstract public  booleanisCompletionRequested()
     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.
abstract public  booleanisFYIRequested()
     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.
public  booleanisStandardSaveAllowed()
     Checks to see if this document is allowed to have a standard 'save' performed true if the saveDocument() method is valid to be called....
abstract public  voidlogDocumentAction(String annotation)
    
abstract public  voidrefreshContent()
    
abstract public  voidremoveAttributeDefinition(WorkflowAttributeDefinitionVO attributeDefinition)
    
abstract public  voidremoveSearchableDefinition(WorkflowAttributeDefinitionVO searchableDefinition)
    
abstract public  voidreturnToPreviousRouteLevel(String annotation, Integer destRouteLevel)
    
abstract public  voidrouteDocument(String annotation)
    
abstract public  voidsaveDocument(String annotation)
    
abstract public  voidsaveRoutingData()
    
abstract public  voidsetAppDocId(String appDocId)
    
abstract public  voidsetApplicationContent(String applicationContent)
     Sets the application specific document content.
abstract public  voidsetTitle(String title)
    
abstract public  booleanstateIsApproved()
     Indicates if the document is in the approved state or not.
abstract public  booleanstateIsCanceled()
     Indicates if the document is in the canceled state or not.
abstract public  booleanstateIsDisapproved()
     Indicates if the document is in the disapproved state or not.
abstract public  booleanstateIsEnroute()
     Indicates if the document is in the enroute state or not.
abstract public  booleanstateIsException()
     Indicates if the document is in the exception state or not.
abstract public  booleanstateIsFinal()
     Indicates if the document is in the final state or not.
abstract public  booleanstateIsInitiated()
     Indicates if the document is in the initated state or not.
abstract public  booleanstateIsProcessed()
     Indicates if the document is in the processed state or not.
abstract public  booleanstateIsSaved()
     Indicates if the document is in the saved state or not.
public  voidsuperUserActionRequestApprove(Long actionRequestId, String annotation)
    
abstract public  voidsuperUserApprove(String annotation)
    
public  voidsuperUserCancel(String annotation)
    
public  voidsuperUserDisapprove(String annotation)
    
public  booleanuserIsInitiator(UniversalUser user)
    
public  booleanuserIsRoutedByUser(UniversalUser user)
    



Method Detail
acknowledge
abstract public void acknowledge(String annotation) throws WorkflowException(Code)



addAttributeDefinition
abstract 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.



addSearchableDefinition
abstract 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.



appSpecificRouteDocumentToUser
abstract public void appSpecificRouteDocumentToUser(String actionRequested, String routeTypeName, int priority, String annotation, UserIdVO recipient, String responsibilityDesc, boolean ignorePreviousActions) throws WorkflowException(Code)



appSpecificRouteDocumentToWorkgroup
abstract public void appSpecificRouteDocumentToWorkgroup(String actionRequested, String routeTypeName, int priority, String annotation, WorkgroupIdVO workgroupId, String responsibilityDesc, boolean ignorePreviousActions) throws WorkflowException(Code)



approve
abstract public void approve(String annotation) throws WorkflowException(Code)



blanketApprove
abstract public void blanketApprove(String annotation) throws WorkflowException(Code)



blanketApprove
abstract public void blanketApprove(String annotation, Integer routeLevel) throws WorkflowException(Code)



cancel
abstract public void cancel(String annotation) throws WorkflowException(Code)



clearAttributeContent
abstract 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. In order for these changes to take effect, an action must be performed on the document (such as "save").



clearAttributeDefinitions
abstract public void clearAttributeDefinitions()(Code)



clearSearchableDefinitions
abstract public void clearSearchableDefinitions()(Code)



complete
abstract public void complete(String annotation) throws WorkflowException(Code)

Parameters:
  annotation -
throws:
  InvalidActionTakenException -
throws:
  ResourceUnavailableException -
throws:
  WorkflowException -



delete
abstract public void delete() throws WorkflowException(Code)



disapprove
abstract public void disapprove(String annotation) throws WorkflowException(Code)



fyi
abstract public void fyi() throws WorkflowException(Code)



getAppDocId
abstract public String getAppDocId()(Code)



getApplicationContent
abstract public String getApplicationContent()(Code)



getAttributeContent
abstract public String getAttributeContent()(Code)
Returns the attribute-generated document content.



getAttributeDefinitions
abstract public WorkflowAttributeDefinitionVO[] getAttributeDefinitions()(Code)



getCreateDate
abstract public Timestamp getCreateDate()(Code)



getCurrentRouteNodeNames
public String getCurrentRouteNodeNames()(Code)
Returns the current node names of the document delimited by the constant: DocumentRouteHeaderValue.CURRENT_ROUTE_NODE_NAME_DELIMITER



getDocRouteLevel
abstract public Integer getDocRouteLevel()(Code)



getDocRouteLevelName
abstract public String getDocRouteLevelName() throws WorkflowException(Code)



getDocumentType
abstract public String getDocumentType()(Code)



getInitiatorNetworkId
abstract public String getInitiatorNetworkId()(Code)



getNodeNames
public String[] getNodeNames() throws WorkflowException(Code)
Returns the names of the nodes that the document is currently at.



getRouteHeader
abstract public RouteHeaderVO getRouteHeader()(Code)



getRouteHeaderId
abstract public Long getRouteHeaderId() throws WorkflowException(Code)



getRouteTypeName
abstract public String getRouteTypeName() throws WorkflowException(Code)



getRoutedByUserNetworkId
abstract public String getRoutedByUserNetworkId()(Code)



getSearchableDefinitions
abstract public WorkflowAttributeDefinitionVO[] getSearchableDefinitions()(Code)



getStatusDisplayValue
abstract public String getStatusDisplayValue()(Code)



getTitle
abstract public String getTitle()(Code)



isAcknowledgeRequested
abstract public boolean isAcknowledgeRequested()(Code)
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. true if the user has the document in their Action List waiting for an Acknowledgement, false otherwise.



isAdHocRequested
public boolean isAdHocRequested()(Code)
This method determines whether workflowDocument.getUserId() currently has an ad hoc request is his/her action list boolean indicating whether there is an active ad hoc request for this user



isApprovalRequested
abstract public boolean isApprovalRequested()(Code)
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. true if the user has the document in their Action List waiting for an Approval, false otherwise.



isBlanketApproveCapable
abstract public boolean isBlanketApproveCapable()(Code)
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. true if the user is authorized to Blanket Approve this document, false otherwise.



isCompletionRequested
abstract public boolean isCompletionRequested()(Code)
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. true if the user has the document in their Action List waiting for a Completion, false otherwise.



isFYIRequested
abstract public boolean isFYIRequested()(Code)
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. true if the user has the document in their Action List waiting for an FYI, false otherwise.



isStandardSaveAllowed
public boolean isStandardSaveAllowed()(Code)
Checks to see if this document is allowed to have a standard 'save' performed true if the saveDocument() method is valid to be called.... false otherwise



logDocumentAction
abstract public void logDocumentAction(String annotation) throws WorkflowException(Code)



refreshContent
abstract public void refreshContent() throws WorkflowException(Code)



removeAttributeDefinition
abstract public void removeAttributeDefinition(WorkflowAttributeDefinitionVO attributeDefinition)(Code)



removeSearchableDefinition
abstract public void removeSearchableDefinition(WorkflowAttributeDefinitionVO searchableDefinition)(Code)



returnToPreviousRouteLevel
abstract public void returnToPreviousRouteLevel(String annotation, Integer destRouteLevel) throws WorkflowException(Code)

Parameters:
  annotation -
Parameters:
  destRouteLevel -
throws:
  WorkflowException -
throws:
  InvalidActionTakenException -
throws:
  ResourceUnavailableException -



routeDocument
abstract public void routeDocument(String annotation) throws WorkflowException(Code)



saveDocument
abstract public void saveDocument(String annotation) throws WorkflowException(Code)



saveRoutingData
abstract public void saveRoutingData() throws WorkflowException(Code)



setAppDocId
abstract public void setAppDocId(String appDocId)(Code)



setApplicationContent
abstract public void setApplicationContent(String applicationContent)(Code)
Sets the application specific document content.



setTitle
abstract public void setTitle(String title) throws WorkflowException(Code)



stateIsApproved
abstract 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
abstract public boolean stateIsCanceled()(Code)
Indicates if the document is in the canceled state or not. true if in the specified state



stateIsDisapproved
abstract public boolean stateIsDisapproved()(Code)
Indicates if the document is in the disapproved state or not. true if in the specified state



stateIsEnroute
abstract public boolean stateIsEnroute()(Code)
Indicates if the document is in the enroute state or not. true if in the specified state



stateIsException
abstract public boolean stateIsException()(Code)
Indicates if the document is in the exception state or not. true if in the specified state



stateIsFinal
abstract public boolean stateIsFinal()(Code)
Indicates if the document is in the final state or not. true if in the specified state



stateIsInitiated
abstract public boolean stateIsInitiated()(Code)
Indicates if the document is in the initated state or not. true if in the specified state



stateIsProcessed
abstract public boolean stateIsProcessed()(Code)
Indicates if the document is in the processed state or not. true if in the specified state



stateIsSaved
abstract public boolean stateIsSaved()(Code)
Indicates if the document is in the saved state or not. true if in the specified state



superUserActionRequestApprove
public void superUserActionRequestApprove(Long actionRequestId, String annotation) throws WorkflowException(Code)



superUserApprove
abstract public void superUserApprove(String annotation) throws WorkflowException(Code)



superUserCancel
public void superUserCancel(String annotation) throws WorkflowException(Code)



superUserDisapprove
public void superUserDisapprove(String annotation) throws WorkflowException(Code)



userIsInitiator
public boolean userIsInitiator(UniversalUser user)(Code)
Returns true if the personUserIdentifier of the given KualiUser matches the initiatorNetworkId of this document
Parameters:
  user - true if the given user is the initiator of this document



userIsRoutedByUser
public boolean userIsRoutedByUser(UniversalUser user)(Code)
Returns true if the personUserIdentifier of the given KualiUser matches the routedByUserNetworkId of this document
Parameters:
  user - true if the given user is the user who routed this document



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.