org.wfmc.wapi2
Interface WAPI2

All Superinterfaces:

WAPI

All Known Subinterfaces:

WMClient, WMLocalClient

public interface WAPI2

extends WAPI

Additional functions described in WfMC-TC-1009 Version 2.0e (Beta).

Author:

Adrian Price

Method Summary

void	addEntityAttributeValue(WMEntity entityHandle, java.lang.String attributeName, int attributeType, java.lang.String attributeValue) Not yet implemented - do not call.
void	addProcessDataAttribute(java.lang.String procModelId, java.lang.String procDataId, java.lang.String attributeName, int attributeType, int attributeLength, java.lang.String attributeValue) Not yet implemented - do not call.
WMEntity	addTransition(java.lang.String procModelId, java.lang.String sourceActDefId, java.lang.String targetActDefId) Not yet implemented - do not call.
void	assignEntityAttributeValue(WMEntity entityHandle, java.lang.String attributeName, int attributeType, java.lang.String attributeValue) Not yet implemented - do not call.
void	clearEntityAttributeList(WMEntity entityHandle, java.lang.String attributeName) Not yet implemented - do not call.
void	closeProcessDefinition(WMEntity procModelHandle) Not yet implemented - do not call.
void	closeWorkflowDefinition(WMEntity workflowDefinitionHandle) Not yet implemented - do not call.
WMEntity	createEntity(WMEntity scopingEntity, java.lang.String entityClass, java.lang.String entityName) Not yet implemented - do not call.
java.lang.String	createPackage() Not yet implemented - do not call.
void	deleteEntity(WMEntity scopingEntity, java.lang.String entityId) Not yet implemented - do not call.
void	deleteProcessDefinition(java.lang.String processDefinitionId) Not yet implemented - do not call.
WMAttribute	getEntityAttributeValue(WMEntity scopingEntity, WMEntity entityHandle, java.lang.String attributeName) Not yet implemented - do not call.
boolean	isActivityAdminProfileSupported()
boolean	isActivityControlStatusProfileSupported()
boolean	isAuditRecordProfileSupported()
boolean	isEntityHandlerProfileSupported()
boolean	isProcessAdminProfileSupported()
boolean	isProcessControlStatusProfileSupported()
boolean	isProcessDefinitionProfileSupported()
boolean	isToolAgentProfileSupported()
boolean	isWorkListHandlerProfileSupported()
WMEntityIterator	listEntities(WMEntity scopingEntity, WMFilter filter, boolean countFlag) Not yet implemented - do not call.
WMAttributeIterator	listEntityAttributes(WMEntity scopingEntity, java.lang.String entityId, WMFilter filter, boolean countFlag) Not yet implemented - do not call.
WMAttributeIterator	listEntityAttributeValues(WMEntity scopingEntity, java.lang.String entityHandle, java.lang.String attributeName) Not yet implemented - do not call.
WMEntity	openProcessDefinition(java.lang.String procDefId) Not yet implemented - do not call.
WMEntity	openWorkflowDefinition(java.lang.String name, java.lang.String scope) Not yet implemented - do not call.
void	removeProcessDataAttribute(java.lang.String procModelId, java.lang.String procDataId, java.lang.String attributeName) Not yet implemented - do not call.

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

Method Detail

isWorkListHandlerProfileSupported

public boolean isWorkListHandlerProfileSupported()

isProcessControlStatusProfileSupported

public boolean isProcessControlStatusProfileSupported()

isProcessDefinitionProfileSupported

public boolean isProcessDefinitionProfileSupported()

isProcessAdminProfileSupported

public boolean isProcessAdminProfileSupported()

isActivityControlStatusProfileSupported

public boolean isActivityControlStatusProfileSupported()

isActivityAdminProfileSupported

public boolean isActivityAdminProfileSupported()

isEntityHandlerProfileSupported

public boolean isEntityHandlerProfileSupported()

isAuditRecordProfileSupported

public boolean isAuditRecordProfileSupported()

isToolAgentProfileSupported

public boolean isToolAgentProfileSupported()

createEntity

public WMEntity createEntity(WMEntity scopingEntity,
                             java.lang.String entityClass,
                             java.lang.String entityName)
                      throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

scopingEntity -

entityClass -

entityName -

Returns:

The workflow entity.

Throws:

WMWorkflowException

listEntities

public WMEntityIterator listEntities(WMEntity scopingEntity,
                                     WMFilter filter,
                                     boolean countFlag)
                              throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

scopingEntity -

filter -

countFlag -

Returns:

An iterator for retrieving the selected entities.

Throws:

WMWorkflowException

deleteEntity

public void deleteEntity(WMEntity scopingEntity,
                         java.lang.String entityId)
                  throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

scopingEntity -

entityId -

Throws:

WMWorkflowException

listEntityAttributes

public WMAttributeIterator listEntityAttributes(WMEntity scopingEntity,
                                                java.lang.String entityId,
                                                WMFilter filter,
                                                boolean countFlag)
                                         throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

scopingEntity -

entityId -

filter -

countFlag -

Returns:

An iterator for retrieving the selected entity attributes.

Throws:

WMWorkflowException

getEntityAttributeValue

public WMAttribute getEntityAttributeValue(WMEntity scopingEntity,
                                           WMEntity entityHandle,
                                           java.lang.String attributeName)
                                    throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

scopingEntity -

entityHandle -

attributeName -

Returns:

The entity attribute value.

Throws:

WMWorkflowException

listEntityAttributeValues

public WMAttributeIterator listEntityAttributeValues(WMEntity scopingEntity,
                                                     java.lang.String entityHandle,
                                                     java.lang.String attributeName)
                                              throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

scopingEntity -

entityHandle -

attributeName -

Returns:

An iterator for retrieving the selected entity attribute values.

Throws:

WMWorkflowException

assignEntityAttributeValue

public void assignEntityAttributeValue(WMEntity entityHandle,
                                       java.lang.String attributeName,
                                       int attributeType,
                                       java.lang.String attributeValue)
                                throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

entityHandle -

attributeName -

attributeType -

attributeValue -

Throws:

WMWorkflowException

clearEntityAttributeList

public void clearEntityAttributeList(WMEntity entityHandle,
                                     java.lang.String attributeName)
                              throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

entityHandle -

attributeName -

Throws:

WMWorkflowException

addEntityAttributeValue

public void addEntityAttributeValue(WMEntity entityHandle,
                                    java.lang.String attributeName,
                                    int attributeType,
                                    java.lang.String attributeValue)
                             throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

entityHandle -

attributeName -

attributeType -

attributeValue -

Throws:

WMWorkflowException

openWorkflowDefinition

public WMEntity openWorkflowDefinition(java.lang.String name,
                                       java.lang.String scope)
                                throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

name -

scope -

Returns:

The workflow definition entity.

Throws:

WMWorkflowException

closeWorkflowDefinition

public void closeWorkflowDefinition(WMEntity workflowDefinitionHandle)
                             throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

workflowDefinitionHandle -

Throws:

WMWorkflowException

createPackage

public java.lang.String createPackage()
                               throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Returns:

The package Id.

Throws:

WMWorkflowException

deleteProcessDefinition

public void deleteProcessDefinition(java.lang.String processDefinitionId)
                             throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

processDefinitionId -

Throws:

WMWorkflowException

openProcessDefinition

public WMEntity openProcessDefinition(java.lang.String procDefId)
                               throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

procDefId -

Returns:

The process definition entity.

Throws:

WMWorkflowException

closeProcessDefinition

public void closeProcessDefinition(WMEntity procModelHandle)
                            throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

procModelHandle -

Throws:

WMWorkflowException

addTransition

public WMEntity addTransition(java.lang.String procModelId,
                              java.lang.String sourceActDefId,
                              java.lang.String targetActDefId)
                       throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

procModelId -

sourceActDefId -

targetActDefId -

Returns:

The transition entity.

Throws:

WMWorkflowException

addProcessDataAttribute

public void addProcessDataAttribute(java.lang.String procModelId,
                                    java.lang.String procDataId,
                                    java.lang.String attributeName,
                                    int attributeType,
                                    int attributeLength,
                                    java.lang.String attributeValue)
                             throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

procModelId -

procDataId -

attributeName -

attributeType -

attributeLength -

attributeValue -

Throws:

WMWorkflowException

removeProcessDataAttribute

public void removeProcessDataAttribute(java.lang.String procModelId,
                                       java.lang.String procDataId,
                                       java.lang.String attributeName)
                                throws WMWorkflowException

Not yet implemented - do not call. This is one of the online Process Definition Profile methods.

Parameters:

procModelId -

procDataId -

attributeName -

Throws:

WMWorkflowException