Java Doc for WAPI.java in  » Workflow-Engines » obe-1.0 » org » wfmc » wapi » 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 » Workflow Engines » obe 1.0 » org.wfmc.wapi 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.wfmc.wapi.WAPI

WAPI
public interface WAPI (Code)
Enables client applications to connect to and interact with a workflow engine.

This interface is based on the WfMC's Interface 2 Client WAPI specification. Some of the methods have been modified from the original specification to fit within the normal design of Java applications. For instance, the WfMC specification functions always return an error object (even for success) and uses out parameters to return values. This interface returns the value and throws an exception when an error occurs. If no error occurs then an exception is not thrown. The C WAPI uses query handles and iterator functions to retrieve collections; this Java binding uses WMIterator .
author:
   Anthony Eden
author:
   Adrian Price





Method Summary
 voidabortProcessInstance(String procInstId)
     Aborts a process instance.
 voidabortProcessInstances(String procDefId, WMFilter filter)
     Aborts a group of process instances.
 voidassignActivityInstanceAttribute(String procInstId, String actInstId, String attrName, Object attrValue)
     Sets the value of an activity instance attribute.
 voidassignActivityInstancesAttribute(String procDefId, String actDefId, WMFilter filter, String attrName, Object attrValue)
     Assigns an attribute value for a group of process instances.
 voidassignProcessInstanceAttribute(String procInstId, String attrName, Object attrValue)
     Sets the specified process instance attribute value.
 voidassignProcessInstancesAttribute(String procDefId, WMFilter filter, String attrName, Object attrValue)
     Assigns an attribute value for a group of process instances.
 voidassignWorkItemAttribute(String procInstId, String workItemId, String attrName, Object attrValue)
     Sets the value of a work item attribute.
 voidchangeActivityInstanceState(String procInstId, String actInstId, WMActivityInstanceState newState)
     Changes the state of an activity instance.
 voidchangeActivityInstancesState(String procDefId, String actDefId, WMFilter filter, WMActivityInstanceState newState)
     Changes the state of selected activity instances.
 voidchangeProcessDefinitionState(String procDefId, WMProcessDefinitionState newState)
     Changes the process definition state.
 voidchangeProcessInstanceState(String procInstId, WMProcessInstanceState newState)
     Changes the state of a process instance.
 voidchangeProcessInstancesState(String procDefId, WMFilter filter, WMProcessInstanceState newState)
     Changes the state of selected process instances.
 voidchangeWorkItemState(String procInstId, String workItemId, WMWorkItemState newState)
     Changes the state of a work item. N.B.
 voidcompleteWorkItem(String procInstId, String workItemId)
     Completes the specified work item.
 voidconnect(WMConnectInfo connectInfo)
     Connects to a workflow service.
Parameters:
  connectInfo - The connection info.
 StringcreateProcessInstance(String procDefId, String procInstName)
     Creates a new process instance for the given process definition.
Parameters:
  procDefId - The process definition id.
Parameters:
  procInstName - The name of the process instance.
 voiddisconnect()
     Disconnects from the workflow service.
 WMActivityInstancegetActivityInstance(String procInstId, String actInstId)
     Retrieves an activity instance.
Parameters:
  procInstId - The process instance id.
Parameters:
  actInstId - The activity instance id.
 WMAttributegetActivityInstanceAttributeValue(String procInstId, String actInstId, String attrName)
     Gets the value of an activity instance attribute.
Parameters:
  procInstId - The process instance id.
Parameters:
  actInstId - The activity instance id.
Parameters:
  attrName - The attribute name.
 WMProcessInstancegetProcessInstance(String procInstId)
     Retrieves a process instance.
Parameters:
  procInstId - The process instance id.
 WMAttributegetProcessInstanceAttributeValue(String procInstId, String attrName)
     Gets the specified process instance attribute value.
Parameters:
  procInstId - The process instance id.
Parameters:
  attrName - The attribute name.
 WMWorkItemgetWorkItem(String procInstId, String workItemId)
     Retrieves a work item.
Parameters:
  procInstId - The process instance id.
Parameters:
  workItemId - The work item id.
 WMAttributegetWorkItemAttributeValue(String procInstId, String workItemId, String attrName)
     Retrieves the value of a work item attribute.
Parameters:
  procInstId - The process instance id.
Parameters:
  workItemId - The work item id.
Parameters:
  attrName - The attribute name.
 voidinvokeApplication(int toolAgentHandle, String appName, String procInstId, String workItemId, Object[] parameters, int appMode)
     Invokes a client-side tool.
 WMAttributeIteratorlistActivityInstanceAttributes(String procInstId, String actInstId, WMFilter filter, boolean countFlag)
     Opens a list of activity instance attributes.
 WMActivityInstanceStateIteratorlistActivityInstanceStates(String procInstId, String actInstId, WMFilter filter, boolean countFlag)
     Opens a list of process instance states.
 WMActivityInstanceIteratorlistActivityInstances(WMFilter filter, boolean countFlag)
     Opens a list of activity instances.
 WMProcessDefinitionStateIteratorlistProcessDefinitionStates(String procDefId, WMFilter filter, boolean countFlag)
     Opens a list of process definition states.
 WMProcessDefinitionIteratorlistProcessDefinitions(WMFilter filter, boolean countFlag)
     Opens a list of process definitions.
 WMAttributeIteratorlistProcessInstanceAttributes(String procInstId, WMFilter filter, boolean countFlag)
     Opens a list of process instance attributes.
 WMProcessInstanceStateIteratorlistProcessInstanceStates(String procInstId, WMFilter filter, boolean countFlag)
     Opens a list of process instance states.
 WMProcessInstanceIteratorlistProcessInstances(WMFilter filter, boolean countFlag)
     Opens a list of process instances.
 WMAttributeIteratorlistWorkItemAttributes(String procInstId, String workItemId, WMFilter filter, boolean countFlag)
     Opens a list of work item attributes.
 WMWorkItemStateIteratorlistWorkItemStates(String procInstId, String workItemId, WMFilter filter, boolean countFlag)
     Opens a list of work item states.
 WMWorkItemIteratorlistWorkItems(WMFilter filter, boolean countFlag)
     Opens a worklist.
 voidreassignWorkItem(String sourceUser, String targetUser, String procInstId, String workItemId)
     Reassigns a work item to another user.
 WMAttribute[]requestAppStatus(int toolAgentHandle, String procInstId, String workItemId, int[] status)
     Requests the status of an invoked tool.
 StringstartProcess(String procInstId)
     Starts a process instance.
 voidterminateApp(int toolAgentHandle, String procInstId, String workItemId)
     Terminates a running tool.
 voidterminateProcessInstance(String procInstId)
     Terminates a process instance.
 voidterminateProcessInstances(String procDefId, WMFilter filter)
     Terminates a group of process instances.



Method Detail
abortProcessInstance
void abortProcessInstance(String procInstId) throws WMWorkflowException(Code)
Aborts a process instance.
Parameters:
  procInstId - The ID of the process instance to abort.
throws:
  WMWorkflowException - Workflow client exception.



abortProcessInstances
void abortProcessInstances(String procDefId, WMFilter filter) throws WMWorkflowException(Code)
Aborts a group of process instances.
Parameters:
  procDefId - The ID of the process definition for whichinstances are to be aborted.
Parameters:
  filter - A filter specification; can be null.
throws:
  WMWorkflowException - Workflow client exception.



assignActivityInstanceAttribute
void assignActivityInstanceAttribute(String procInstId, String actInstId, String attrName, Object attrValue) throws WMWorkflowException(Code)
Sets the value of an activity instance attribute.
Parameters:
  procInstId - The process instance id.
Parameters:
  actInstId - The activity instance id.
Parameters:
  attrName - The attribute name.
Parameters:
  attrValue - The attribute value.
throws:
  WMWorkflowException - Workflow client exception.



assignActivityInstancesAttribute
void assignActivityInstancesAttribute(String procDefId, String actDefId, WMFilter filter, String attrName, Object attrValue) throws WMWorkflowException(Code)
Assigns an attribute value for a group of process instances.
Parameters:
  procDefId - The ID of the process definition for whichactivity instance attributes are to be assigned.
Parameters:
  actDefId - The ID of the activity definition for whichinstance attributes are to be assigned.
Parameters:
  filter - A filter specification; can be null.
Parameters:
  attrName - The attribute name.
Parameters:
  attrValue - The attribute value.
throws:
  WMWorkflowException - Workflow client exception.



assignProcessInstanceAttribute
void assignProcessInstanceAttribute(String procInstId, String attrName, Object attrValue) throws WMWorkflowException(Code)
Sets the specified process instance attribute value.
Parameters:
  procInstId - The process instance id.
Parameters:
  attrName - The attribute name.
Parameters:
  attrValue - The attribute value.
throws:
  WMWorkflowException - Workflow client exception.



assignProcessInstancesAttribute
void assignProcessInstancesAttribute(String procDefId, WMFilter filter, String attrName, Object attrValue) throws WMWorkflowException(Code)
Assigns an attribute value for a group of process instances.
Parameters:
  procDefId - The ID of the process definition for whichinstance attributes are to be assigned.
Parameters:
  filter - A filter specification; can be null.
Parameters:
  attrName - The attribute name.
Parameters:
  attrValue - The attribute value.
throws:
  WMWorkflowException - Workflow client exception.



assignWorkItemAttribute
void assignWorkItemAttribute(String procInstId, String workItemId, String attrName, Object attrValue) throws WMWorkflowException(Code)
Sets the value of a work item attribute.
Parameters:
  procInstId - The process instance id.
Parameters:
  workItemId - The work item id.
Parameters:
  attrName - The attribute name.
Parameters:
  attrValue - The attribute value.
throws:
  WMWorkflowException - Workflow client exception.



changeActivityInstanceState
void changeActivityInstanceState(String procInstId, String actInstId, WMActivityInstanceState newState) throws WMWorkflowException(Code)
Changes the state of an activity instance.
Parameters:
  procInstId - The process instance id.
Parameters:
  actInstId - The activity instance id.
Parameters:
  newState - The new activity instance state.
throws:
  WMWorkflowException - Workflow client exception.



changeActivityInstancesState
void changeActivityInstancesState(String procDefId, String actDefId, WMFilter filter, WMActivityInstanceState newState) throws WMWorkflowException(Code)
Changes the state of selected activity instances.
Parameters:
  procDefId - The ID of the process definition for whichactivity instances are to be changed.
Parameters:
  actDefId - The ID of the activity definition for whichinstances are to be changed.
Parameters:
  filter - A filter specification; can be null.
Parameters:
  newState - The new state to apply.
throws:
  WMWorkflowException - Workflow client exception.



changeProcessDefinitionState
void changeProcessDefinitionState(String procDefId, WMProcessDefinitionState newState) throws WMWorkflowException(Code)
Changes the process definition state.
Parameters:
  procDefId - The process definition id.
Parameters:
  newState - The new process definition state.
throws:
  WMWorkflowException - Workflow client exception.



changeProcessInstanceState
void changeProcessInstanceState(String procInstId, WMProcessInstanceState newState) throws WMWorkflowException(Code)
Changes the state of a process instance.
Parameters:
  procInstId - The process instance id.
Parameters:
  newState - The new process instance state.
throws:
  WMWorkflowException - Workflow client exception.



changeProcessInstancesState
void changeProcessInstancesState(String procDefId, WMFilter filter, WMProcessInstanceState newState) throws WMWorkflowException(Code)
Changes the state of selected process instances.
Parameters:
  procDefId - The ID of the process definition for whichinstances are to be changed.
Parameters:
  filter - A filter specification; can be null.
Parameters:
  newState - The new state to apply.
throws:
  WMWorkflowException - Workflow client exception.



changeWorkItemState
void changeWorkItemState(String procInstId, String workItemId, WMWorkItemState newState) throws WMWorkflowException(Code)
Changes the state of a work item. N.B. The signature of this method differs from that described in the WAPI2 specification, in that it has a procInstId parameter. This is because the specification's definition for this function is clearly in error, having been badly copied from that for WMChangeDefinitionState. The other WAPI functions that refer to work items invariably require the procInstId parameter.
Parameters:
  procInstId - The process instance id.
Parameters:
  workItemId - The work item id.
Parameters:
  newState - The new work item state.
throws:
  WMWorkflowException - Workflow client exception.



completeWorkItem
void completeWorkItem(String procInstId, String workItemId) throws WMWorkflowException(Code)
Completes the specified work item.
Parameters:
  procInstId - The process instance id.
Parameters:
  workItemId - The work item id.
throws:
  WMWorkflowException - Workflow client exception.



connect
void connect(WMConnectInfo connectInfo) throws WMWorkflowException(Code)
Connects to a workflow service.
Parameters:
  connectInfo - The connection info. In OBE, pass nullto skip the JAAS login and retain the current security identity (if any).
throws:
  WMWorkflowException - Workflow client exception.



createProcessInstance
String createProcessInstance(String procDefId, String procInstName) throws WMWorkflowException(Code)
Creates a new process instance for the given process definition.
Parameters:
  procDefId - The process definition id.
Parameters:
  procInstName - The name of the process instance. The process instance id.
throws:
  WMWorkflowException - Workflow client exception.



disconnect
void disconnect() throws WMWorkflowException(Code)
Disconnects from the workflow service.
throws:
  WMWorkflowException - Workflow client exception.



getActivityInstance
WMActivityInstance getActivityInstance(String procInstId, String actInstId) throws WMWorkflowException(Code)
Retrieves an activity instance.
Parameters:
  procInstId - The process instance id.
Parameters:
  actInstId - The activity instance id. The activity instance.
throws:
  WMWorkflowException - Workflow client exception.



getActivityInstanceAttributeValue
WMAttribute getActivityInstanceAttributeValue(String procInstId, String actInstId, String attrName) throws WMWorkflowException(Code)
Gets the value of an activity instance attribute.
Parameters:
  procInstId - The process instance id.
Parameters:
  actInstId - The activity instance id.
Parameters:
  attrName - The attribute name. The attribute.
throws:
  WMWorkflowException - Workflow client exception.



getProcessInstance
WMProcessInstance getProcessInstance(String procInstId) throws WMWorkflowException(Code)
Retrieves a process instance.
Parameters:
  procInstId - The process instance id. The process instance.
throws:
  WMWorkflowException - Workflow client exception.



getProcessInstanceAttributeValue
WMAttribute getProcessInstanceAttributeValue(String procInstId, String attrName) throws WMWorkflowException(Code)
Gets the specified process instance attribute value.
Parameters:
  procInstId - The process instance id.
Parameters:
  attrName - The attribute name. The attribute.
throws:
  WMWorkflowException - Workflow client exception.



getWorkItem
WMWorkItem getWorkItem(String procInstId, String workItemId) throws WMWorkflowException(Code)
Retrieves a work item.
Parameters:
  procInstId - The process instance id.
Parameters:
  workItemId - The work item id. The work item.
throws:
  WMWorkflowException - Workflow client exception.



getWorkItemAttributeValue
WMAttribute getWorkItemAttributeValue(String procInstId, String workItemId, String attrName) throws WMWorkflowException(Code)
Retrieves the value of a work item attribute.
Parameters:
  procInstId - The process instance id.
Parameters:
  workItemId - The work item id.
Parameters:
  attrName - The attribute name. The attribute.
throws:
  WMWorkflowException - Workflow client exception.



invokeApplication
void invokeApplication(int toolAgentHandle, String appName, String procInstId, String workItemId, Object[] parameters, int appMode) throws WMWorkflowException(Code)
Invokes a client-side tool.
Parameters:
  toolAgentHandle -
Parameters:
  appName - The tag name of the tool.
Parameters:
  procInstId - The ID of the associated process instance.
Parameters:
  workItemId - The ID of the associated work item.
Parameters:
  parameters - Parameters to pass to the tool.
Parameters:
  appMode - Application mode, one of:
throws:
  WMWorkflowException - Workflow client exception.



listActivityInstanceAttributes
WMAttributeIterator listActivityInstanceAttributes(String procInstId, String actInstId, WMFilter filter, boolean countFlag) throws WMWorkflowException(Code)
Opens a list of activity instance attributes. The items in the attribute list can be retrieved sequentially in a typesafe way by calling the iterator's tsNext() method.
Parameters:
  procInstId - The process instance id.
Parameters:
  actInstId - The activity instance id.
Parameters:
  filter - The filter or null.
Parameters:
  countFlag - True to return count value. An iterator to access the WMAttribute objects.
throws:
  WMWorkflowException - Workflow client exception.



listActivityInstanceStates
WMActivityInstanceStateIterator listActivityInstanceStates(String procInstId, String actInstId, WMFilter filter, boolean countFlag) throws WMWorkflowException(Code)
Opens a list of process instance states. The items in the state list can be retrieved sequentially in a typesafe way by calling the iterator's tsNext() method.
Parameters:
  procInstId - The process instance id.
Parameters:
  actInstId - The activity instance id.
Parameters:
  filter - The filter or null.
Parameters:
  countFlag - True to return count value. An iterator to access the WMActivityInstanceState objects.
throws:
  WMWorkflowException - Workflow client exception.



listActivityInstances
WMActivityInstanceIterator listActivityInstances(WMFilter filter, boolean countFlag) throws WMWorkflowException(Code)
Opens a list of activity instances. The items in the list can be retrieved sequentially in a typesafe way by calling the iterator's tsNext() method.
Parameters:
  filter - The filter or null.
Parameters:
  countFlag - True to return count value. An iterator to access the WMActivityInstance objects.
throws:
  WMWorkflowException - Workflow client exception.



listProcessDefinitionStates
WMProcessDefinitionStateIterator listProcessDefinitionStates(String procDefId, WMFilter filter, boolean countFlag) throws WMWorkflowException(Code)
Opens a list of process definition states. The items in the state list can be retrieved sequentially in a typesafe way by calling the iterator's tsNext() method.
Parameters:
  procDefId - The unique process definition ID.
Parameters:
  filter - The filter or null.
Parameters:
  countFlag - True to return count value. An iterator to access the WMProcessDefinitionStateobjects.
throws:
  WMWorkflowException - Workflow client exception.



listProcessDefinitions
WMProcessDefinitionIterator listProcessDefinitions(WMFilter filter, boolean countFlag) throws WMWorkflowException(Code)
Opens a list of process definitions. The items in the list can be retrieved sequentially in a typesafe way by calling the iterator's tsNext() method.
Parameters:
  filter - The filter or null.
Parameters:
  countFlag - True to return count value. An iterator to access the WMProcessDefinition objects.
throws:
  WMWorkflowException - Workflow client exception.



listProcessInstanceAttributes
WMAttributeIterator listProcessInstanceAttributes(String procInstId, WMFilter filter, boolean countFlag) throws WMWorkflowException(Code)
Opens a list of process instance attributes. The items in the attribute list can be retrieved sequentially in a typesafe way by calling the iterator's tsNext() method.
Parameters:
  filter - The filter or null.
Parameters:
  countFlag - True to return count value. An iterator to access the WMAttribute objects.
throws:
  WMWorkflowException - Workflow client exception.



listProcessInstanceStates
WMProcessInstanceStateIterator listProcessInstanceStates(String procInstId, WMFilter filter, boolean countFlag) throws WMWorkflowException(Code)
Opens a list of process instance states. The items in the state list can be retrieved sequentially in a typesafe way by calling the iterator's tsNext() method.
Parameters:
  procInstId - The unique process instance ID.
Parameters:
  filter - The filter or null.
Parameters:
  countFlag - True to return count value. An iterator to access the WMProcessInstanceState objects.
throws:
  WMWorkflowException - Workflow client exception.



listProcessInstances
WMProcessInstanceIterator listProcessInstances(WMFilter filter, boolean countFlag) throws WMWorkflowException(Code)
Opens a list of process instances. The items in the list can be retrieved sequentially in a typesafe way by calling the iterator's tsNext() method.
Parameters:
  filter - The filter or null.
Parameters:
  countFlag - True to return count value. An iterator to access the WMProcessInstance objects.
throws:
  WMWorkflowException - Workflow client exception.



listWorkItemAttributes
WMAttributeIterator listWorkItemAttributes(String procInstId, String workItemId, WMFilter filter, boolean countFlag) throws WMWorkflowException(Code)
Opens a list of work item attributes. The items in the attribute list can be retrieved sequentially in a typesafe way by calling the iterator's tsNext() method.
Parameters:
  procInstId - The process instance id.
Parameters:
  workItemId - The work item id.
Parameters:
  filter - The filter or null.
Parameters:
  countFlag - True to return count value. An iterator to access the WMAttribute objects.
throws:
  WMWorkflowException - Workflow client exception.



listWorkItemStates
WMWorkItemStateIterator listWorkItemStates(String procInstId, String workItemId, WMFilter filter, boolean countFlag) throws WMWorkflowException(Code)
Opens a list of work item states. The items in the work item states list can be retrieved sequentially in a typesafe way by calling the iterator's tsNext() method.

N.B. This function is poorly documented in the WfMC specification, which contains several 'copy/paste' errors.

N.B. The signature of this method differs from that described in the WAPI2 specification, in that it has a procInstId parameter. This is because the specification's definition for this function is clearly in error, having been copied badly from that for WMOpenProcessDefinitionStatesList. The other WAPI functions that refer to work items invariably require the procInstId parameter.
Parameters:
  procInstId - The process instance id.
Parameters:
  workItemId - The process instance id.
Parameters:
  filter - The filter or null.
Parameters:
  countFlag - True to return count value. An iterator to access the WMWorkItemState objects.
throws:
  WMWorkflowException - Workflow client exception.




listWorkItems
WMWorkItemIterator listWorkItems(WMFilter filter, boolean countFlag) throws WMWorkflowException(Code)
Opens a worklist. The items in the list can be retrieved sequentially using the iterator's tsNext() method.
Parameters:
  filter - The filter or null.
Parameters:
  countFlag - True to return count value. An iterator to access the WMWorkItem objects.
throws:
  WMWorkflowException - Workflow client exception.



reassignWorkItem
void reassignWorkItem(String sourceUser, String targetUser, String procInstId, String workItemId) throws WMWorkflowException(Code)
Reassigns a work item to another user.
Parameters:
  sourceUser - The current user.
Parameters:
  targetUser - The new user.
Parameters:
  procInstId - The process instance id.
Parameters:
  workItemId - The work item id.
throws:
  WMWorkflowException - Workflow client exception.



requestAppStatus
WMAttribute[] requestAppStatus(int toolAgentHandle, String procInstId, String workItemId, int[] status) throws WMWorkflowException(Code)
Requests the status of an invoked tool.
Parameters:
  toolAgentHandle - The tool handle, returned by the prior callto WAPI.invokeApplication.
Parameters:
  procInstId - The ID of the associated process instance.
Parameters:
  workItemId - The ID of the associated work item.
Parameters:
  status - The status of specified tool.
throws:
  WMWorkflowException - Workflow client exception.



startProcess
String startProcess(String procInstId) throws WMWorkflowException(Code)
Starts a process instance. The process instance id is retrieved from a prior call to createProcessInstance()
Parameters:
  procInstId - The process instance id retrieved in a priorcall to createProcessInstance(). The new process instance id (which may be the same as the old).
throws:
  WMWorkflowException - Workflow client exception.



terminateApp
void terminateApp(int toolAgentHandle, String procInstId, String workItemId) throws WMWorkflowException(Code)
Terminates a running tool.
Parameters:
  toolAgentHandle -
Parameters:
  procInstId - The ID of the associated process instance.
Parameters:
  workItemId - The ID of the associated work item.
throws:
  WMWorkflowException - Workflow client exception.



terminateProcessInstance
void terminateProcessInstance(String procInstId) throws WMWorkflowException(Code)
Terminates a process instance.
Parameters:
  procInstId - The process instance id.
throws:
  WMWorkflowException - Workflow client exception.



terminateProcessInstances
void terminateProcessInstances(String procDefId, WMFilter filter) throws WMWorkflowException(Code)
Terminates a group of process instances.
Parameters:
  procDefId - The ID of the process definition for whichinstances are to be terminated.
Parameters:
  filter - A filter specification; can be null.
throws:
  WMWorkflowException - Workflow client exception.



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