org.obe.client.api
Interface WMClient

All Superinterfaces:

WAPI, WAPI2

All Known Subinterfaces:

WMLocalClient

public interface WMClient

extends WAPI2

WAPI2 extensions for process definition and instance management. The process repository functions provide for pluggable process definition language support; at present only XPDL is supported.

The WAPI superinterface provides many methods that accept a 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, ProcessInstanceAttributes, ActivityInstanceAttributes, WorkItemAttributes

Field Summary

static java.lang.String	BPEL4WS IBM/Microsoft/BEA's Business Process Execution Language for Web Services.
static java.lang.String	BPML BPMI's Business Process Modeling Language.
static java.lang.String	WPDL WfMC's Workflow Process Definition Language.
static java.lang.String	WSFL IBM's Web Services Flow Language.
static java.lang.String	WSPL BPMI's Web Services Process Language.
static java.lang.String	XLANG Microsoft's BizTalk Process Definition Language.
static java.lang.String	XPDL WfMC's XML Process Definition Language.

Method Summary

java.lang.String	createPackage(java.lang.String content, java.lang.String contentType) Creates a package using the supplied content in a specified format.
java.lang.String	createPackage(XPDLPackage pkg) Creates a package using the supplied content.
java.lang.String	createProcessInstanceVersioned(java.lang.String name, java.lang.String processInstanceName) Creates a new instance of the named workflow process.
int	deleteAuditEntries(WMFilter filter) Deletes audit entries matching a user-supplied criterion.
void	deletePackage(java.lang.String packageId) Permanently deletes the specified process definition.
void	deleteProcessInstance(java.lang.String processInstanceId) Deletes a process instance from persistent storage.
void	deleteProcessInstances(java.lang.String processDefinitionId, WMFilter filter) Deletes a process instance from persistent storage.
ToolInvocation[]	executeWorkItem(java.lang.String procInstId, java.lang.String workItemId) Returns information to enable a client to invoke a tool.
XPDLPackage	getPackage(java.lang.String packageId) Retrieves an XPDL package.
java.lang.String	getPackageContent(java.lang.String packageId, java.lang.String contentType) Retrieves the content of the a package in the specified format.
java.lang.String	getProtocol() Returns the protocol in use by this client instance.
WMAAuditEntryIterator	listAuditEntries(WMFilter filter) Finds audit entries matching a user-supplied criterion.
void	setPackageContent(java.lang.String packageId, java.lang.String content, java.lang.String contentType) Sets the content of the specified package.
void	toolFinished(java.lang.String procInstId, java.lang.String workItemId, int appStatus, Parameter[] parms) Informs the workflow engine that a tool has finished executing.
void	toolStarted(java.lang.String procInstId, java.lang.String workItemId) Informs the workflow engine that a tool is being started.
void	updatePackage(XPDLPackage pkg) Updates the specified process definition package.

Methods inherited from interface org.wfmc.wapi2.WAPI2

addEntityAttributeValue, addProcessDataAttribute, addTransition, assignEntityAttributeValue, clearEntityAttributeList, closeProcessDefinition, closeWorkflowDefinition, createEntity, createPackage, deleteEntity, deleteProcessDefinition, getEntityAttributeValue, isActivityAdminProfileSupported, isActivityControlStatusProfileSupported, isAuditRecordProfileSupported, isEntityHandlerProfileSupported, isProcessAdminProfileSupported, isProcessControlStatusProfileSupported, isProcessDefinitionProfileSupported, isToolAgentProfileSupported, isWorkListHandlerProfileSupported, listEntities, listEntityAttributes, listEntityAttributeValues, openProcessDefinition, openWorkflowDefinition, removeProcessDataAttribute

Methods inherited from interface org.wfmc.wapi.WAPI

abortProcessInstance, abortProcessInstances, assignActivityInstanceAttribute, assignActivityInstancesAttribute, assignProcessInstanceAttribute, assignProcessInstancesAttribute, assignWorkItemAttribute, changeActivityInstancesState, changeActivityInstanceState, changeProcessDefinitionState, changeProcessInstancesState, changeProcessInstanceState, changeWorkItemState, completeWorkItem, connect, createProcessInstance, disconnect, getActivityInstance, getActivityInstanceAttributeValue, getProcessInstance, getProcessInstanceAttributeValue, getWorkItem, getWorkItemAttributeValue, invokeApplication, listActivityInstanceAttributes, listActivityInstances, listActivityInstanceStates, listProcessDefinitions, listProcessDefinitionStates, listProcessInstanceAttributes, listProcessInstances, listProcessInstanceStates, listWorkItemAttributes, listWorkItems, listWorkItemStates, reassignWorkItem, requestAppStatus, startProcess, terminateApp, terminateProcessInstance, terminateProcessInstances

Field Detail

BPEL4WS

public static final java.lang.String BPEL4WS

IBM/Microsoft/BEA's Business Process Execution Language for Web Services.

See Also:

Constant Field Values

BPML

public static final java.lang.String BPML

BPMI's Business Process Modeling Language.

See Also:

Constant Field Values

WPDL

public static final java.lang.String WPDL

WfMC's Workflow Process Definition Language.

See Also:

Constant Field Values

WSFL

public static final java.lang.String WSFL

IBM's Web Services Flow Language.

See Also:

Constant Field Values

WSPL

public static final java.lang.String WSPL

BPMI's Web Services Process Language.

See Also:

Constant Field Values

XLANG

public static final java.lang.String XLANG

Microsoft's BizTalk Process Definition Language.

See Also:

Constant Field Values

XPDL

public static final java.lang.String XPDL

WfMC's XML Process Definition Language.

See Also:

Constant Field Values

Method Detail

getProtocol

public java.lang.String getProtocol()

Returns the protocol in use by this client instance.

Returns:

The client protocol.

createPackage

public java.lang.String createPackage(XPDLPackage pkg)
                               throws WMWorkflowException

Creates a package using the supplied content.

Parameters:

pkg - Package definition.

Returns:

The ID of the new package.

Throws:

WMWorkflowException

updatePackage

public void updatePackage(XPDLPackage pkg)
                   throws WMWorkflowException

Updates the specified process definition package.

Parameters:

pkg - The process definition package.

Throws:

WMWorkflowException

createPackage

public java.lang.String createPackage(java.lang.String content,
                                      java.lang.String contentType)
                               throws WMWorkflowException

Creates a package using the supplied content in a specified format.

Parameters:

content - Package definition in specified format.

contentType - The MIME content type of the package definition, in a supported format.

Returns:

The ID of the new package.

Throws:

WMWorkflowException

getPackage

public XPDLPackage getPackage(java.lang.String packageId)
                       throws WMWorkflowException

Retrieves an XPDL package.

Parameters:

packageId - The package ID.

Returns:

The XPDL package.

Throws:

WMWorkflowException

getPackageContent

public java.lang.String getPackageContent(java.lang.String packageId,
                                          java.lang.String contentType)
                                   throws WMWorkflowException

Retrieves the content of the a package in the specified format.

Parameters:

packageId - The package ID.

contentType - The MIME content type of the package definition, must be a supported format.

Returns:

Package definition in XPDL format.

Throws:

WMWorkflowException

setPackageContent

public void setPackageContent(java.lang.String packageId,
                              java.lang.String content,
                              java.lang.String contentType)
                       throws WMWorkflowException

Sets the content of the specified package.

Parameters:

packageId - The ID of the package to update.

content - Package definition in a supported format.

contentType - The MIME content type of the package definition, must be a supported format.

Throws:

WMWorkflowException

deletePackage

public void deletePackage(java.lang.String packageId)
                   throws WMWorkflowException

Permanently deletes the specified process definition.

Parameters:

packageId - The process definition ID.

Throws:

WMWorkflowException

createProcessInstanceVersioned

public java.lang.String createProcessInstanceVersioned(java.lang.String name,
                                                       java.lang.String processInstanceName)
                                                throws WMWorkflowException

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.

processInstanceName - The name of the process instance.

Returns:

The process instance id.

Throws:

WMInvalidProcessDefinitionException - if the process definition does not exist, is disabled, under revision, or has no valid versions as determined for the current system time.

WMWorkflowException - Workflow client exception

deleteProcessInstance

public void deleteProcessInstance(java.lang.String processInstanceId)
                           throws WMWorkflowException

Deletes a process instance from persistent storage.

Parameters:

processInstanceId - The ID of the process instance to delete.

Throws:

WMWorkflowException

deleteProcessInstances

public void deleteProcessInstances(java.lang.String processDefinitionId,
                                   WMFilter filter)
                            throws WMWorkflowException

Deletes a process instance from persistent storage.

Parameters:

processDefinitionId - The ID of the process definition for which to delete instances.

filter - A filter specification; can be null.

Throws:

WMWorkflowException

listAuditEntries

public WMAAuditEntryIterator listAuditEntries(WMFilter filter)
                                       throws WMWorkflowException

Finds audit entries matching a user-supplied criterion.

Parameters:

filter - Filter criterion.

Returns:

The matching audit entries.

Throws:

WMWorkflowException

deleteAuditEntries

public int deleteAuditEntries(WMFilter filter)
                       throws WMWorkflowException

Deletes audit entries matching a user-supplied criterion.

Parameters:

filter - Filter criterion.

Returns:

The count of audit entries deleted.

Throws:

WMWorkflowException

executeWorkItem

public ToolInvocation[] executeWorkItem(java.lang.String procInstId,
                                        java.lang.String workItemId)
                                 throws WMWorkflowException

Returns information to enable a client to invoke a tool. The returned 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.

workItemId - The work item ID.

Returns:

Tool invocation information.

Throws:

WMWorkflowException

toolStarted

public void toolStarted(java.lang.String procInstId,
                        java.lang.String workItemId)
                 throws WMWorkflowException

Informs the workflow engine that a tool is being started.

Parameters:

procInstId - The process instance ID.

workItemId - The work item ID.

Throws:

WMWorkflowException

toolFinished

public void toolFinished(java.lang.String procInstId,
                         java.lang.String workItemId,
                         int appStatus,
                         Parameter[] parms)
                  throws WMWorkflowException

Informs the workflow engine that a tool has finished executing.

Parameters:

procInstId - The process instance ID.

workItemId - The work item ID.

appStatus - The application exit status.

parms - Parameters containing output results.

Throws:

WMWorkflowException