Java Doc for WorkflowClient.java in  » ERP-CRM-Financial » SourceTap-CRM » org » ofbiz » workflow » client » 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 » SourceTap CRM » org.ofbiz.workflow.client 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.ofbiz.workflow.client.WorkflowClient

WorkflowClient
public class WorkflowClient (Code)
Workflow Client - Client API to the Workflow Engine.
author:
   Andy Zeneski
version:
   $Revision: 1.1 $
since:
   2.0


Field Summary
protected  GenericDelegatordelegator
    
protected  LocalDispatcherdispatcher
    
final public static  Stringmodule
    

Constructor Summary
protected  WorkflowClient()
    
public  WorkflowClient(GenericDelegator delegator, LocalDispatcher dispatcher)
    
public  WorkflowClient(DispatchContext context)
    

Method Summary
public  voidabortProcess(String workEffortId)
    
public  voidaccept(String workEffortId, String partyId, String roleTypeId, Timestamp fromDate)
     Accept an activity assignment.
public  voidacceptAndStart(String workEffortId, String partyId, String roleTypeId, Timestamp fromDate)
     Accept an activity assignment and begin processing.
Parameters:
  workEffortId - The WorkEffort entity ID for the activitiy.
Parameters:
  partyId - The assigned / to be assigned users party ID.
Parameters:
  roleTypeId - The assigned / to be assigned role type ID.
Parameters:
  fromDate - The assignment's from date.
public  voidappendContext(String workEffortId, Map append)
     Append data to the execution object's process context.
public  WfAssignmentassign(String workEffortId, String partyId, String roleTypeId, Timestamp fromDate, boolean append)
     Create an activity assignment.
Parameters:
  workEffortId - The WorkEffort entity ID for the activitiy.
Parameters:
  partyId - The assigned / to be assigned users party ID.
Parameters:
  roleTypeId - The assigned / to be assigned role type ID.
Parameters:
  append - Append this assignment to the list, if others exist.
public  voidcomplete(String workEffortId, String partyId, String roleTypeId, Timestamp fromDate, Map result)
     Complete an activity assignment and follow the next transition(s).
Parameters:
  workEffortId - The WorkEffort entity ID for the activity.
Parameters:
  partyId - The assigned / to be assigned users party ID.
Parameters:
  roleTypeId - The assigned / to be assigned role type ID.
Parameters:
  fromDate - The assignment's from date.
public  WfAssignmentdelegate(String workEffortId, String fromPartyId, String fromRoleTypeId, Timestamp fromFromDate, String toPartyId, String toRoleTypeId, Timestamp toFromDate)
     Delegate an activity assignment.
Parameters:
  workEffortId - The WorkEffort entity ID for the activitiy.
Parameters:
  fromPartyId - The current assignment partyId.
Parameters:
  fromRoleTypeId - The current assignment roleTypeId.
Parameters:
  fromFromDate - The current assignment fromDate.
Parameters:
  toPartyId - The new delegated assignment partyId.
Parameters:
  toRoleTypeId - The new delegated assignment roleTypeId.
Parameters:
  toFromDate - The new delegated assignment fromDate.
public  voiddelegateAndAccept(String workEffortId, String fromPartyId, String fromRoleTypeId, Timestamp fromFromDate, String toPartyId, String toRoleTypeId, Timestamp toFromDate, boolean start)
     Delegate and accept an activity assignment.
Parameters:
  workEffortId - The WorkEffort entity ID for the activitiy.
Parameters:
  partyId - The assigned / to be assigned users party ID.
Parameters:
  roleTypeId - The assigned / to be assigned role type ID.
Parameters:
  fromDate - The assignment's from date.
Parameters:
  start - True to attempt to start the activity.
public  MapgetContext(String workEffortId)
     Returns the process context of the execution object.
public  longgetPriority(String workEffortId)
     Gets the priority of the execution object defined by the work effort key.
Parameters:
  workEffortId - The WorkEffort entity key for the execution object.
public  StringgetState(String workEffortId)
     Gets the state of the execution object defined by the work effort key.
public  voidresume(String workEffortId)
    
public  voidsetPriority(String workEffortId, long priority)
     Set the priority of the execution object defined by the work effort key.
public  voidsetState(String workEffortId, String state)
     Set the state of the execution object defined by the work effort key.
Parameters:
  workEffortId - The WorkEffort entity key for the execution object.
Parameters:
  state - The new state of the execution object.
public  voidstart(String workEffortId)
     Start the activity.
Parameters:
  workEffortId - The WorkEffort entity ID for the activitiy.
public  voidsuspend(String workEffortId)
    

Field Detail
delegator
protected GenericDelegator delegator(Code)



dispatcher
protected LocalDispatcher dispatcher(Code)



module
final public static String module(Code)




Constructor Detail
WorkflowClient
protected WorkflowClient()(Code)



WorkflowClient
public WorkflowClient(GenericDelegator delegator, LocalDispatcher dispatcher)(Code)
Get a new instance of the Workflow Client
Parameters:
  delegator - the GenericDelegator object which matchs the delegator used by the workflow engine.
Parameters:
  dispatcher - a LocalDispatcher object to invoke the workflow services.



WorkflowClient
public WorkflowClient(DispatchContext context)(Code)
Get a new instance of the Workflow Client
Parameters:
  dctx - A DispatchContext object.Note the delegator from this object must match the delegator used by the workflow engine.




Method Detail
abortProcess
public void abortProcess(String workEffortId) throws WfException(Code)
Abort a process
Parameters:
  workEffortId - The workeffort entity key for the process to abort
throws:
  WfException -



accept
public void accept(String workEffortId, String partyId, String roleTypeId, Timestamp fromDate) throws WfException(Code)
Accept an activity assignment.
Parameters:
  workEffortId - The WorkEffort entity ID for the activitiy.
Parameters:
  partyId - The assigned / to be assigned users party ID.
Parameters:
  roleTypeId - The assigned / to be assigned role type ID.
Parameters:
  fromDate - The assignment's from date.
throws:
  WfException -



acceptAndStart
public void acceptAndStart(String workEffortId, String partyId, String roleTypeId, Timestamp fromDate) throws WfException(Code)
Accept an activity assignment and begin processing.
Parameters:
  workEffortId - The WorkEffort entity ID for the activitiy.
Parameters:
  partyId - The assigned / to be assigned users party ID.
Parameters:
  roleTypeId - The assigned / to be assigned role type ID.
Parameters:
  fromDate - The assignment's from date. GenericResultWaiter of the start job.
throws:
  WfException -



appendContext
public void appendContext(String workEffortId, Map append) throws WfException(Code)
Append data to the execution object's process context.
Parameters:
  workEffortId - The WorkEffort entity key for the execution object.
Parameters:
  append - The data to append.
throws:
  WfException -



assign
public WfAssignment assign(String workEffortId, String partyId, String roleTypeId, Timestamp fromDate, boolean append) throws WfException(Code)
Create an activity assignment.
Parameters:
  workEffortId - The WorkEffort entity ID for the activitiy.
Parameters:
  partyId - The assigned / to be assigned users party ID.
Parameters:
  roleTypeId - The assigned / to be assigned role type ID.
Parameters:
  append - Append this assignment to the list, if others exist. The new assignment object.
throws:
  WfException -



complete
public void complete(String workEffortId, String partyId, String roleTypeId, Timestamp fromDate, Map result) throws WfException(Code)
Complete an activity assignment and follow the next transition(s).
Parameters:
  workEffortId - The WorkEffort entity ID for the activity.
Parameters:
  partyId - The assigned / to be assigned users party ID.
Parameters:
  roleTypeId - The assigned / to be assigned role type ID.
Parameters:
  fromDate - The assignment's from date. GenericResultWaiter for the complete job.
throws:
  WfException -



delegate
public WfAssignment delegate(String workEffortId, String fromPartyId, String fromRoleTypeId, Timestamp fromFromDate, String toPartyId, String toRoleTypeId, Timestamp toFromDate) throws WfException(Code)
Delegate an activity assignment.
Parameters:
  workEffortId - The WorkEffort entity ID for the activitiy.
Parameters:
  fromPartyId - The current assignment partyId.
Parameters:
  fromRoleTypeId - The current assignment roleTypeId.
Parameters:
  fromFromDate - The current assignment fromDate.
Parameters:
  toPartyId - The new delegated assignment partyId.
Parameters:
  toRoleTypeId - The new delegated assignment roleTypeId.
Parameters:
  toFromDate - The new delegated assignment fromDate. The new assignment object.
throws:
  WfException -



delegateAndAccept
public void delegateAndAccept(String workEffortId, String fromPartyId, String fromRoleTypeId, Timestamp fromFromDate, String toPartyId, String toRoleTypeId, Timestamp toFromDate, boolean start) throws WfException(Code)
Delegate and accept an activity assignment.
Parameters:
  workEffortId - The WorkEffort entity ID for the activitiy.
Parameters:
  partyId - The assigned / to be assigned users party ID.
Parameters:
  roleTypeId - The assigned / to be assigned role type ID.
Parameters:
  fromDate - The assignment's from date.
Parameters:
  start - True to attempt to start the activity. GenericResultWaiter of the start job.
throws:
  WfException -



getContext
public Map getContext(String workEffortId) throws WfException(Code)
Returns the process context of the execution object.
Parameters:
  workEffortId - The WorkEffort entity key for the execution object.
throws:
  WfException -



getPriority
public long getPriority(String workEffortId) throws WfException(Code)
Gets the priority of the execution object defined by the work effort key.
Parameters:
  workEffortId - The WorkEffort entity key for the execution object. Priority of the execution object as a long.
throws:
  WfException -



getState
public String getState(String workEffortId) throws WfException(Code)
Gets the state of the execution object defined by the work effort key.
Parameters:
  workEffortId - The WorkEffort entity key for the execution object.
throws:
  WfException -



resume
public void resume(String workEffortId) throws WfException(Code)
Resume an activity
Parameters:
  workEffortId - The WorkEffort entity key for the activity object
throws:
  WfException -



setPriority
public void setPriority(String workEffortId, long priority) throws WfException(Code)
Set the priority of the execution object defined by the work effort key.
Parameters:
  workEffortId - The WorkEffort entity key for the execution object.
Parameters:
  priority - The new priority of the execution object.
throws:
  WfException - If state change is not allowed.



setState
public void setState(String workEffortId, String state) throws WfException(Code)
Set the state of the execution object defined by the work effort key.
Parameters:
  workEffortId - The WorkEffort entity key for the execution object.
Parameters:
  state - The new state of the execution object. Current state of the execution object as a string.
throws:
  WfException - If state change is not allowed.



start
public void start(String workEffortId) throws WfException(Code)
Start the activity.
Parameters:
  workEffortId - The WorkEffort entity ID for the activitiy. GenericResultWaiter of the start job.
throws:
  WfException -



suspend
public void suspend(String workEffortId) throws WfException(Code)
Suspend an activity
Parameters:
  workEffortId - The WorkEffort entity key for the activity object
throws:
  WfException -



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

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