| org.obe.client.api.WMClient
All known Subclasses: org.obe.client.api.base.AbstractJAASClient, org.obe.client.api.xmlrpc.WMXmlRpcClient,
| WMClient | | public interface WMClient extends WAPI2(Code) | | WAPI2 extensions for process definition and instance management. The
process repository functions provide for pluggable process definition
language support; at present only
WMClient.XPDL is supported.
The
WAPI superinterface provides many methods that accept a
WMFilter filter object to restrict the scope of the operation. The
filter refers to attributes of process instance, activity instance, and work
item as appropriate. In OBE, these system attributes are described by
interfaces in the
org.obe.client.api.model package.
author:
Adrian Price
See Also: WMClientFactory
See Also: ProcessInstanceAttributes
See Also: ActivityInstanceAttributes
See Also: WorkItemAttributes |
| Field Summary | |
| String | BPEL4WS
IBM/Microsoft/BEA's Business Process Execution Language for Web Services. | | String | BPML
BPMI's Business Process Modeling Language. | | String | WPDL
WfMC's Workflow Process Definition Language. | | String | WSFL
IBM's Web Services Flow Language. | | String | WSPL
BPMI's Web Services Process Language. | | String | XLANG
Microsoft's BizTalk Process Definition Language. | | String | XPDL
WfMC's XML Process Definition Language. |
| Method Summary | |
| String | createPackage(XPDLPackage pkg)
Creates a package using the supplied content.
Parameters:
pkg - Package definition. | | String | createPackage(String content, String contentType)
Creates a package using the supplied content in a specified format.
Parameters:
content - Package definition in specified format.
Parameters:
contentType - The MIME content type of the package definition, in asupported format. | | String | createProcessInstanceVersioned(String name, String processInstanceName)
Creates a new instance of the named workflow process. | | int | deleteAuditEntries(WMFilter filter)
Deletes audit entries matching a user-supplied criterion.
Parameters:
filter - Filter criterion. | | void | deletePackage(String packageId)
Permanently deletes the specified process definition. | | void | deleteProcessInstance(String processInstanceId)
Deletes a process instance from persistent storage. | | void | deleteProcessInstances(String processDefinitionId, WMFilter filter)
Deletes a process instance from persistent storage. | | ToolInvocation[] | executeWorkItem(String procInstId, String workItemId)
Returns information to enable a client to invoke a tool. | | XPDLPackage | getPackage(String packageId)
Retrieves an XPDL package.
Parameters:
packageId - The package ID. | | String | getPackageContent(String packageId, String contentType)
Retrieves the content of the a package in the specified format.
Parameters:
packageId - The package ID.
Parameters:
contentType - The MIME content type of the package definition, mustbe a supported format. | | String | getProtocol()
Returns the protocol in use by this client instance. | | WMAAuditEntryIterator | listAuditEntries(WMFilter filter)
Finds audit entries matching a user-supplied criterion.
Parameters:
filter - Filter criterion. | | void | setPackageContent(String packageId, String content, String contentType)
Sets the content of the specified package. | | void | toolFinished(String procInstId, String workItemId, int appStatus, Parameter[] parms)
Informs the workflow engine that a tool has finished executing. | | void | toolStarted(String procInstId, String workItemId)
Informs the workflow engine that a tool is being started. | | void | updatePackage(XPDLPackage pkg)
Updates the specified process definition package. |
| BPEL4WS | | String BPEL4WS(Code) | | IBM/Microsoft/BEA's Business Process Execution Language for Web Services.
|
| BPML | | String BPML(Code) | | BPMI's Business Process Modeling Language.
|
| WPDL | | String WPDL(Code) | | WfMC's Workflow Process Definition Language.
|
| WSPL | | String WSPL(Code) | | BPMI's Web Services Process Language.
|
| XLANG | | String XLANG(Code) | | Microsoft's BizTalk Process Definition Language.
|
| XPDL | | String XPDL(Code) | | WfMC's XML Process Definition Language.
|
| createPackage | | String createPackage(String content, String contentType) throws WMWorkflowException(Code) | | Creates a package using the supplied content in a specified format.
Parameters:
content - Package definition in specified format.
Parameters:
contentType - The MIME content type of the package definition, in asupported format. The ID of the new package.
throws:
WMWorkflowException - |
| createProcessInstanceVersioned | | String createProcessInstanceVersioned(String name, String processInstanceName) throws WMWorkflowException(Code) | | Creates a new instance of the named workflow process. The system
instantiates the 'most valid' version of the named process, based on the
versioning metadata in the ProcessHeader (ValidFrom, ValidTo).
Parameters:
name - The process definition name.
Parameters:
processInstanceName - The name of the process instance. The process instance id.
throws:
WMInvalidProcessDefinitionException - if the process definitiondoes not exist, is disabled, under revision, or has no valid versions asdetermined for the current system time.
throws:
WMWorkflowException - Workflow client exception |
| deleteProcessInstance | | void deleteProcessInstance(String processInstanceId) throws WMWorkflowException(Code) | | Deletes a process instance from persistent storage.
Parameters:
processInstanceId - The ID of the process instance to delete.
throws:
WMWorkflowException - |
| deleteProcessInstances | | void deleteProcessInstances(String processDefinitionId, WMFilter filter) throws WMWorkflowException(Code) | | Deletes a process instance from persistent storage.
Parameters:
processDefinitionId - The ID of the process definition for whichto delete instances.
Parameters:
filter - A filter specification; can be null.
throws:
WMWorkflowException - |
| executeWorkItem | | ToolInvocation[] executeWorkItem(String procInstId, String workItemId) throws WMWorkflowException(Code) | | Returns information to enable a client to invoke a tool. The returned
ToolInvocation ToolInvocations can either be used directly to
invoke the Application (in the case of a thick client), or can be used to
render a response document (in the case of a thin client such as a
web-based worklist handler).
Parameters:
procInstId - The process instance ID.
Parameters:
workItemId - The work item ID. Tool invocation information.
throws:
WMWorkflowException - |
| getPackageContent | | String getPackageContent(String packageId, String contentType) throws WMWorkflowException(Code) | | Retrieves the content of the a package in the specified format.
Parameters:
packageId - The package ID.
Parameters:
contentType - The MIME content type of the package definition, mustbe a supported format. Package definition in XPDL format.
throws:
WMWorkflowException - |
| getProtocol | | String getProtocol()(Code) | | Returns the protocol in use by this client instance.
The client protocol. |
| setPackageContent | | void setPackageContent(String packageId, String content, String contentType) throws WMWorkflowException(Code) | | Sets the content of the specified package.
Parameters:
packageId - The ID of the package to update.
Parameters:
content - Package definition in a supported format.
Parameters:
contentType - The MIME content type of the package definition, mustbe a supported format.
throws:
WMWorkflowException - |
| toolFinished | | void toolFinished(String procInstId, String workItemId, int appStatus, Parameter[] parms) throws WMWorkflowException(Code) | | Informs the workflow engine that a tool has finished executing.
Parameters:
procInstId - The process instance ID.
Parameters:
workItemId - The work item ID.
Parameters:
appStatus - The application exit status.
Parameters:
parms - Parameters containing output results.
throws:
WMWorkflowException - |
|
|