com.ibm.bpe.api

Interface BusinessFlowManager

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT 
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      ClientObjectWrapper call(java.lang.String processTemplateName, ClientObjectWrapper inputMessage)
      Creates and executes a process instance that is derived from the specified process template.
      ClientObjectWrapper call(java.lang.String vtid, java.lang.String atid, ClientObjectWrapper inputMessage)
      Creates and executes a process instance using a string representation of the activity service template ID and the activity template ID.
      ClientObjectWrapper call(java.lang.String processTemplateName, java.lang.String nameSpace, java.lang.String portType, java.lang.String operation, ClientObjectWrapper inputMessage)
      Creates and executes a process instance that is derived from the specified process template by calling the specified starting service.
      ClientObjectWrapper call(VTID vtid, ATID atid, ClientObjectWrapper inputMessage)
      Creates and executes a process instance using the activity service template ID and the activity template ID.
      void callServiceWithReplyContext(java.lang.String vtid, java.lang.String atid, java.lang.String processInstanceName, ClientObjectWrapper inputMessage, ReplyContextWrapper replyContext, int invocationCount, java.lang.String requestId)
      Creates and executes a process instance using the activity service template ID and the activity template ID and asynchronously waits for the result.
      void callServiceWithReplyContext(VTID vtid, ATID atid, java.lang.String processInstanceName, ClientObjectWrapper inputMessage, ReplyContextWrapper replyContext, int invocationCount, java.lang.String requestId)
      Creates and executes a process instance using the activity service template ID and the activity template ID and asynchronously waits for the result.
      void callWithReplyContext(java.lang.String processTemplateName, ClientObjectWrapper inputMessage, ReplyContextWrapper replyContext)
      Creates and executes a process instance from the specified process template and asynchronously waits for the result.
      void callWithReplyContext(java.lang.String processTemplateName, ClientObjectWrapper inputMessage, ReplyContextWrapper replyContext, int invocationCount, java.lang.String requestId)
      Creates and executes a process instance from the specified process template and asynchronously waits for the result of the uniquely identified request.
      void callWithReplyContext(java.lang.String processTemplateName, java.lang.String processInstanceName, ClientObjectWrapper inputMessage, ReplyContextWrapper replyContext)
      Creates and executes a named process instance from the specified process template and asynchronously waits for the result.
      void callWithReplyContext(java.lang.String processTemplateName, java.lang.String processInstanceName, ClientObjectWrapper inputMessage, ReplyContextWrapper replyContext, int invocationCount, java.lang.String requestId)
      Creates and executes a named process instance from the specified process template and asynchronously waits for the result of the uniquely identified request.
      ProcessResponseWrapper callWithUISettings(java.lang.String processTemplateName, ClientObjectWrapper inputMessage)
      Creates and executes a process instance that is derived from the specified process template and returns the output message as well as its client UI settings.
      ProcessResponseWrapper callWithUISettings(java.lang.String vtid, java.lang.String atid, ClientObjectWrapper inputMessage)
      Creates and executes a process instance using a string representation of the activity service template ID and the activity template ID and returns the output message as well as its client UI settings.
      ProcessResponseWrapper callWithUISettings(VTID vtid, ATID atid, ClientObjectWrapper inputMessage)
      Creates and executes a process instance using the activity service template ID and the activity template ID and returns the output message as well as its client UI settings.
      void cancelClaim(AIID aiid)
      Cancels the claim of an activity instance using the activity instance ID.
      void cancelClaim(AIID aiid, boolean keepData)
      Cancels the claim of an activity instance and keeps any data that has been set using the activity instance ID.
      void cancelClaim(java.lang.String aiid)
      Cancels the claim of an activity instance using a string representation of the activity instance ID.
      void cancelClaim(java.lang.String aiid, boolean keepData)
      Cancels the claim of an activity instance and keeps any data that has been set using a string representation of the activity instance ID.
      void cancelSkipRequest(AIID aiid)
      Cancels the skip request for the activity instance using the activity instance ID.
      void cancelSkipRequest(PIID piid, java.lang.String activityName)
      Cancels the skip request for the specified activity instance using the associated process instance ID and the activity instance name.
      void cancelSkipRequest(java.lang.String aiid)
      Cancels the skip request for the activity instance using a string representation of the activity instance ID.
      void cancelSkipRequest(java.lang.String piid, java.lang.String activityName)
      Cancels the skip request for the specified activity instance using a string representation of the associated process instance ID and the activity name.
      ClientObjectWrapper claim(AIID aiid)
      Claims a ready activity instance for user processing using the activity instance ID.
      ClientObjectWrapper claim(java.lang.String aiid)
      Claims a ready activity instance for user processing using a string representation of the activity instance ID.
      ActivityInstanceData claim(java.lang.String whereClause, java.lang.String orderByClause, java.util.TimeZone timeZone)
      Claims a ready activity instance for user processing.
      void claimProcessOwnership(PIID piid)
      Claims the ownership for the specified process instance using the process instance ID.
      void claimProcessOwnership(java.lang.String piid)
      Claims the ownership for the specified process instance using a string representation of the process instance ID.
      void complete(AIID aiid)
      Completes a claimed activity instance using the activity instance ID.
      void complete(AIID aiid, ClientObjectWrapper output)
      Completes a claimed activity instance using the activity instance ID and passes the result of user processing.
      void complete(AIID aiid, ClientObjectWrapper faultMessage, java.lang.String faultName)
      Completes a claimed activity instance using the activity instance ID and denotes the failing of user processing.
      void complete(java.lang.String aiid)
      Completes a claimed activity instance using a string representation of the activity instance ID.
      void complete(java.lang.String aiid, ClientObjectWrapper output)
      Completes a claimed activity instance using a string representation of the activity instance ID and passes the result of user processing.
      void complete(java.lang.String aiid, ClientObjectWrapper faultMessage, java.lang.String faultName)
      Completes a claimed activity instance using a string representation of the activity instance ID and denotes the failing of user processing.
      CompleteAndClaimSuccessorResult completeAndClaimSuccessor(AIID aiid, ClientObjectWrapper output)
      Completes a claimed activity instance using the activity instance ID and claims a successor activity.
      CompleteAndClaimSuccessorResult completeAndClaimSuccessor(java.lang.String aiid, ClientObjectWrapper output)
      Completes a claimed activity instance using a string representation of the activity instance ID and claims a successor activity.
      void completeAndJump(AIID aiid, ClientObjectWrapper output, java.lang.String targetActivityName)
      Completes a claimed activity instance using the activity instance ID and some output and continues navigation at the specified target activity.
      void completeAndJump(AIID aiid, java.lang.String targetActivityName)
      Completes a claimed activity instance using the activity instance ID and continues navigation at the specified target activity.
      void completeAndJump(java.lang.String aiid, ClientObjectWrapper output, java.lang.String targetActivityName)
      Completes a claimed activity instance using a string representation of the activity instance ID and some output and continues navigation at the specified target activity.
      void completeAndJump(java.lang.String aiid, java.lang.String targetActivityName)
      Completes a claimed activity instance using a string representation of the activity instance ID and continues navigation at the specified target activity.
      ClientObjectWrapper createMessage(AIID aiid, java.lang.String messageTypeName)
      Creates a message defined by the specified activity instance using the activity instance ID.
      ClientObjectWrapper createMessage(EHTID ehtid, java.lang.String messageTypeName)
      Creates a message defined by the specified event handler template using the event handler template ID.
      ClientObjectWrapper createMessage(PIID piid, java.lang.String messageTypeName)
      Creates a message defined by the specified process instance using the process instance ID.
      ClientObjectWrapper createMessage(PTID ptid, java.lang.String messageTypeName)
      Creates a message defined by the specified process template using the process template ID.
      ClientObjectWrapper createMessage(java.lang.String identifier, java.lang.String messageTypeName)
      Creates a message defined by the specified process template, process instance, activity instance, or event handler template using a string representation of the object ID.
      ClientObjectWrapper createMessage(java.lang.String vtid, java.lang.String atid, java.lang.String messageTypeName)
      Creates a message defined by the specified activity service using string representations of object IDs.
      ClientObjectWrapper createMessage(VTID vtid, ATID atid, java.lang.String messageTypeName)
      Creates a message defined by the specified activity service using object IDs.
      ClientObjectWrapper createMessageWithCorrelationSets(AIID aiid, java.lang.String messageTypeName)
      Creates a message defined by the specified activity instance using the activity instance ID and sets the values that are available for initialized correlation sets.
      ClientObjectWrapper createMessageWithCorrelationSets(java.lang.String aiid, java.lang.String messageTypeName)
      Creates a message defined by the specified activity instance using a string representation of the activity instance ID and sets the values that are available for initialized correlation sets.
      ClientObjectWrapper createMessageWithCorrelationSets(java.lang.String vtid, java.lang.String atid, java.lang.String piid, java.lang.String messageTypeName)
      Creates a message defined by the specified activity service using string representations of object IDs and sets the values that are available for initialized correlation sets.
      ClientObjectWrapper createMessageWithCorrelationSets(VTID vtid, ATID atid, PIID piid, java.lang.String messageTypeName)
      Creates a message defined by the specified activity service using object IDs and sets the values that are available for initialized correlation sets.
      ClientObjectWrapper createMessageWithCorrelationSetsForEventHandler(EHTID ehtid, PIID piid)
      Creates a message defined by the specified event handler using the event handler object ID and sets the values that are available for initialized correlation sets.
      ClientObjectWrapper createMessageWithCorrelationSetsForEventHandler(java.lang.String ehtid, java.lang.String piid)
      Creates a message defined by the specified event handler using a string representation of the event handler template ID and sets the values that are available for initialized correlation sets.
      void createStoredQuery(java.lang.String storedQueryName, java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer threshold, java.util.TimeZone timeZone)
      Creates a query definition and persistently stores it in the database for general usage.
      void createStoredQuery(java.lang.String storedQueryName, java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer threshold, java.util.TimeZone timeZone, java.util.List storedQueryProperties, java.lang.String clientType)
      Creates a query definition and specifies properties to be stored together with the query.
      void createStoredQuery(java.lang.String userID, java.lang.String storedQueryName, java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer threshold, java.util.TimeZone timeZone, java.util.List storedQueryProperties, java.lang.String clientType)
      Creates a query definition for the specified user.
      void createWorkItem(AIID aiid, int assignmentReason, java.lang.String userID)
      Creates a work item for activities with the specified assignment reason for the specified activity instance and user.
      void createWorkItem(PIID piid, int assignmentReason, java.lang.String userID)
      Creates a work item for processes with the specified assignment reason for the specified process instance and user.
      void createWorkItem(java.lang.String identifier, int assignmentReason, java.lang.String userID)
      Creates a work item for processes or activities using a string representation of either the process or activity instance ID.
      void delete(PIID piid)
      Deletes the specified top-level process instance and its non-autonomous subprocesses and tasks using the process instance ID.
      void delete(java.lang.String piid)
      Deletes the specified top-level process instance and its non-autonomous subprocesses and tasks using a string representation of the process instance ID or the process instance name.
      void deleteStoredQuery(java.lang.String storedQueryName)
      Deletes the specified stored query.
      void deleteStoredQuery(java.lang.String userID, java.lang.String storedQueryName)
      Deletes the specified stored query for the specified user.
      void deleteWorkItem(AIID aiid, int assignmentReason, java.lang.String userID)
      Deletes the specified work item for the specified activity instance.
      void deleteWorkItem(PIID piid, int assignmentReason, java.lang.String userID)
      Deletes the specified work item for the specified process instance.
      void deleteWorkItem(java.lang.String identifier, int assignmentReason, java.lang.String userID)
      Deletes the specified work item using a string representation of either the process or activity instance ID.
      void deleteWorkList(java.lang.String workListName)
      Deprecated. 
      As of version 6.0, replaced by deleteStoredQuery.
      QueryResultSet executeWorkList(java.lang.String workListName)
      Deprecated. 
      As of version 6.0, replaced by query.
      java.util.List findQueryTableMetaData(MetaDataOptions metaDataOptions)
      Queries the meta data of query tables.
      void forceComplete(AIID aiid, boolean continueOnError)
      Forces the completion of an activity instance using the activity instance ID.
      void forceComplete(AIID aiid, ClientObjectWrapper output, boolean continueOnError)
      Forces the completion of an activity instance using the activity instance ID and an output messsage.
      void forceComplete(AIID aiid, ClientObjectWrapper message, java.lang.String faultName, boolean continueOnError)
      Forces the completion of an activity instance using the activity instance ID and states the actual result of user processing.
      void forceComplete(java.lang.String aiid, boolean continueOnError)
      Forces the completion of an activity instance using a string representation of the activity instance ID.
      void forceComplete(java.lang.String aiid, ClientObjectWrapper output, boolean continueOnError)
      Forces the completion of an activity instance using a string representation of the activity instance ID and an output message.
      void forceComplete(java.lang.String aiid, ClientObjectWrapper message, java.lang.String faultName, boolean continueOnError)
      Forces the completion of an activity instance using a string representation of the activity instance ID and states the actual result of user processing.
      void forceCompleteAndJump(AIID aiid, ClientObjectWrapper output, java.lang.String targetActivityName)
      Forces the completion of an activity instance using the activity instance ID and continues navigation at the specified target activity.
      void forceCompleteAndJump(java.lang.String aiid, ClientObjectWrapper output, java.lang.String targetActivityName)
      Forces the completion of an activity instance using a string representation of the activity instance ID and continues navigation at the specified target activity.
      void forceForEachCounterValues(AIID aiid, int startCounter, int finalCounter, java.lang.Integer maxCompletedBranches)
      Forces the navigation of an activity instance that stopped because the evaluation of for-each counter values failed using the activity instance ID.
      void forceForEachCounterValues(java.lang.String aiid, int startCounter, int finalCounter, java.lang.Integer maxCompletedBranches)
      Forces the navigation of an activity instance that stopped because the evaluation of for-each counter values failed using a string representation of the activity instance ID.
      void forceJoinCondition(AIID aiid, boolean conditionValue)
      Forces the navigation of an activity instance that stopped because the join condition evaluation failed using the activity instance ID.
      void forceJoinCondition(java.lang.String aiid, boolean conditionValue)
      Forces the navigation of an activity instance that stopped because the join condition evaluation failed using a string representation of the activity instance ID.
      void forceLoopCondition(AIID aiid, boolean conditionValue)
      Forces the navigation of an activity instance that stopped because a loop condition evaluation failed using the activity instance ID.
      void forceLoopCondition(java.lang.String aiid, boolean conditionValue)
      Forces the navigation of an activity instance that stopped because a loop condition evaluation failed using a string representation of the activity instance ID.
      void forceNavigate(AIID aiid, int positionOfBranch)
      Forces the navigation of a branch of the specified switch activity using the activity instance ID.
      void forceNavigate(AIID aiid, java.lang.String[] linksToBeFollowed)
      Forces the navigation of links leaving the specified activity instance using the activity instance ID.
      void forceNavigate(java.lang.String aiid, int positionOfBranch)
      Forces the navigation of a branch of the specified switch activity using a string representation of the activity instance ID.
      void forceNavigate(java.lang.String aiid, java.lang.String[] linksToBeFollowed)
      Forces the navigation of links leaving the specified activity instance using a string representation of the activity instance ID.
      void forceRetry(AIID aiid, boolean continueOnError)
      Forces the repetition of an activity instance using the activity instance ID.
      void forceRetry(AIID aiid, boolean continueOnError, int timerBehavior)
      Forces the repetition of an activity instance using the activity instance ID and specifies how to handle timers.
      void forceRetry(AIID aiid, ClientObjectWrapper inputMessage, boolean continueOnError)
      Forces the repetition of an activity instance using the activity instance ID and an input message.
      void forceRetry(AIID aiid, ClientObjectWrapper inputMessage, boolean continueOnError, int timerBehavior)
      Forces the repetition of an activity instance using the activity instance ID and passes an input message and a timer specification.
      void forceRetry(java.lang.String aiid, boolean continueOnError)
      Forces the repetition of an activity instance using a string representation of the activity instance ID.
      void forceRetry(java.lang.String aiid, boolean continueOnError, int timerBehavior)
      Forces the repetition of an activity instance using a string representation of the activity instance ID and specifies how to handle timers.
      void forceRetry(java.lang.String aiid, ClientObjectWrapper inputMessage, boolean continueOnError)
      Forces the repetition of an activity instance using a string representation of the activity instance ID and an input message.
      void forceRetry(java.lang.String aiid, ClientObjectWrapper inputMessage, boolean continueOnError, int timerBehavior)
      Forces the repetition of an activity instance using a string representation of the activity instance ID and passes an input message and a timer specification.
      void forceTerminate(PIID piid)
      Terminates the specified top-level process instance, its non-autonomous subprocesses, and its running, claimed, or waiting activities using the process instance ID.
      void forceTerminate(PIID piid, int invokeCompensation)
      Terminates the specified top-level process instance, its non-autonomous subprocesses, its running, claimed, or waiting activities using the process instance ID.
      void forceTerminate(java.lang.String identifier)
      Terminates the specified top-level process instance, its non-autonomous subprocesses, and its running, claimed, or waiting activities using a string representation of the process instance ID or the process instance name.
      void forceTerminate(java.lang.String identifier, int invokeCompensation)
      Terminates the specified top-level process instance, its non-autonomous subprocesses, its running, claimed, or waiting activities using a string representation of the process instance ID or the process instance name.
      EventHandlerTemplateData[] getActiveEventHandlers(PIID piid)
      Retrieves the active event handlers of the specified process instance using the process instance ID.
      EventHandlerTemplateData[] getActiveEventHandlers(java.lang.String piid)
      Retrieves the active event handlers of the specified process instance using a string representation of the process instance object ID.
      ActivityInstanceData getActivityInstance(AIID aiid)
      Retrieves the specified activity instance using the activity instance ID.
      ActivityInstanceData getActivityInstance(PIID piid, java.lang.String activityTemplateName)
      Retrieves the specified activity instance using the process instance ID and the activity template name.
      ActivityInstanceData getActivityInstance(java.lang.String aiid)
      Retrieves the specified activity instance using a string representation of the activity instance ID.
      ActivityInstanceData getActivityInstance(java.lang.String piid, java.lang.String activityTemplateName)
      Retrieves the specified activity instance using a string representation of the process instance ID and the activity template name.
      ActivityServiceTemplateData getActivityServiceTemplate(java.lang.String vtid, java.lang.String atid)
      Retrieves the specified activity service template using string representations of the associated object IDs.
      ActivityServiceTemplateData getActivityServiceTemplate(VTID vtid, ATID atid)
      Retrieves the specified activity service template using the associated object IDs.
      QueryResultSet getAllActivities(PIID piid, java.util.TimeZone timezone)
      Queries pre-defined activity instance properties of activities directly contained in the specified process instance using the process instance ID.
      QueryResultSet getAllActivities(java.lang.String piid, java.util.TimeZone timezone)
      Queries pre-defined activity instance properties of activities directly contained in the specified process instance using a string representation of the process instance ID.
      java.util.List getAllBasicActivityNames(PIID piid)
      Retrieves the names of all basic activities that are part of the specified process instance using the process instance ID.
      java.util.List getAllBasicActivityNames(java.lang.String piid)
      Retrieves the names of all basic activities that are part of the specified process instance using a string representation of the process instance ID.
      java.util.List getAllCustomProperties(PIID piid)
      Retrieves all custom properties of the specified process instance using the process instance ID.
      java.util.List getAllCustomProperties(PTID ptid)
      Retrieves all custom properties of the specified process template using the process template ID.
      java.util.List getAllCustomProperties(java.lang.String identifier)
      Retrieves all custom properties of the specified process template or process instance using a string representation of the object ID.
      java.util.List getAllQueryProperties(java.lang.String propertyNameFilter, java.lang.Integer threshold)
      Retrieves the query properties of all process templates.
      java.util.List getAllVariableNames(AIID aiid)
      Retrieves the names of all variables visible by the specified activity instance using the activity instance ID.
      java.util.List getAllVariableNames(PIID piid)
      Retrieves the names of all variables visible by the specified process instance using the process instance ID.
      java.util.List getAllVariableNames(PIID piid, java.lang.String activityName)
      Retrieves the names of all variables visible by the specified activity using the process instance ID and the activity name.
      java.util.List getAllVariableNames(java.lang.String identifier)
      Retrieves the names of all variables visible by the specified process or activity instance using a string representation of the process or activity instance ID.
      java.util.List getAllVariableNames(java.lang.String piid, java.lang.String activityName)
      Retrieves the names of all variables visible by the specified activity using a string representation of the process instance ID and the activity name.
      WorkItemData[] getAllWorkItems(AIID aiid)
      Retrieves all work item assignments associated to the specified activity instance using the activity instance ID.
      WorkItemData[] getAllWorkItems(PIID piid)
      Retrieves all work item assignments associated to the specified process instance using the process instance ID.
      WorkItemData[] getAllWorkItems(java.lang.String identifier)
      Retrieves all work item assignments associated to the specified process or activity instance using a string representation of the process or activity instance ID.
      boolean[][] getAvailableActionFlags(AIID[] aiids)
      Returns indicators to state the actions that can be called in the current activity instance states by the logged-on user using activity instance IDs.
      boolean[][] getAvailableActionFlags(PIID[] piids)
      Returns indicators to state the actions that can be called in the current process instance states by the logged-on user using process instance IDs.
      boolean[][] getAvailableActionFlags(java.lang.String[] identifiers)
      Returns indicators to state the actions that can be called in the current process instance states or in the current activity instance states by the logged-on user.
      BfmConfiguration getBfmConfiguration()
      Returns configuration settings of the Business Flow Manager.
      BinaryCustomProperty getBinaryCustomProperty(AIID aiid, java.lang.String propertyName)
      Retrieves the named binary custom property of the specified activity instance using the activity instance object ID.
      BinaryCustomProperty getBinaryCustomProperty(PIID piid, java.lang.String propertyName)
      Retrieves the named binary custom property of the specified process instance using the process instance the object ID.
      BinaryCustomProperty getBinaryCustomProperty(PIID piid, java.lang.String activityName, java.lang.String propertyName)
      Retrieves the named binary custom property of the specified activity instance using the process instance ID and the activity name.
      BinaryCustomProperty getBinaryCustomProperty(java.lang.String identifier, java.lang.String propertyName)
      Retrieves the named binary custom property of the specified process or activity instance using a string representation of the object ID.
      BinaryCustomProperty getBinaryCustomProperty(java.lang.String piid, java.lang.String activityName, java.lang.String propertyName)
      Retrieves the named binary custom property of the specified activity instance using a string representation of the process instance ID and the activity name.
      java.util.List getBinaryCustomPropertyNames(AIID aiid)
      Retrieves the names of all binary custom properties of the specified activity instance using the activity instance ID.
      java.util.List getBinaryCustomPropertyNames(PIID piid)
      Retrieves the names of all binary custom properties of the specified process instance using the process instance ID.
      java.util.List getBinaryCustomPropertyNames(PIID piid, java.lang.String activityName)
      Retrieves the names of all binary custom property of the specified activity instance using the process instance ID and the activity name.
      java.util.List getBinaryCustomPropertyNames(java.lang.String identifier)
      Retrieves the names of all binary custom properties of the specified process or activity instance using a string representation of the process or activity instance ID.
      java.util.List getBinaryCustomPropertyNames(java.lang.String piid, java.lang.String activityName)
      Retrieves the names of all binary custom property of the specified activity instance using a string representation of the process instance ID and the activity name.
      BranchTemplateData[] getBranches(AIID aiid)
      Retrieves information about the branches of the specified switch activity instance using the activity instance ID.
      BranchTemplateData[] getBranches(java.lang.String aiid)
      Retrieves information about the branches of the specified switch activity instance using a string representation of the activity instance object ID.
      CustomClientSettings getClientUISettings(AIID aiid)
      Retrieves client interface settings for the specified activity instance using the activity instance ID.
      CustomClientSettings getClientUISettings(PIID piid)
      Retrieves client interface settings for the specified process instance using the process instance ID.
      CustomClientSettings getClientUISettings(PTID ptid)
      Retrieves client interface settings for the specified process template using the process template ID.
      CustomClientSettings getClientUISettings(java.lang.String identifier)
      Retrieves client interface settings for the specified process template, process instance, or activity instance using a string representation of the object ID.
      CustomClientSettings getClientUISettings(java.lang.String vtid, java.lang.String atid)
      Retrieves client interface settings for the specified service using a string representation of the activity and service object IDs.
      CustomClientSettings getClientUISettings(VTID vtid, ATID atid)
      Retrieves client interface settings for the specified service using the activity and service object IDs.
      java.util.List getCorrelationSetInstances(AIID aiid, java.lang.String messageTypeName)
      Retrieves the correlation set instances of the specified activity instance and message type using the activity instance ID.
      java.util.List getCorrelationSetInstances(PIID piid)
      Retrieves the correlation set instances of the specified process instance using the process instance ID.
      java.util.List getCorrelationSetInstances(java.lang.String piid)
      Retrieves the correlation set instances of the specified process instance using a string representation of the process instance ID.
      java.util.List getCorrelationSetInstances(java.lang.String aiid, java.lang.String messageTypeName)
      Retrieves the correlation set instances of the specified activity instance and message type using a string representation of the activity instance ID.
      java.util.List getCustomProperties(AIID aiid)
      Retrieves the custom properties of the specified activity instance using the activity instance ID.
      java.util.List getCustomProperties(PIID piid)
      Retrieves the custom properties of the specified process instance using the process instance ID.
      java.util.List getCustomProperties(PIID piid, java.lang.String activityName)
      Retrieves the custom properties of the specified activity instance using using the process instance ID and the activity name.
      java.util.List getCustomProperties(PTID ptid)
      Retrieves the custom properties of the specified process template using the process template ID.
      java.util.List getCustomProperties(java.lang.String identifier)
      Retrieves the custom properties of the specified process template, process instance, or activity instance using a string representation of the object ID.
      java.util.List getCustomProperties(java.lang.String identifier, java.lang.String activityName)
      Retrieves the custom properties of the specified activity instance using a string representation of the process instance ID and the activity name.
      java.lang.String getCustomProperty(AIID aiid, java.lang.String propertyName)
      Retrieves the named custom property of the specified activity instance using the activity instance ID.
      java.lang.String getCustomProperty(PIID piid, java.lang.String propertyName)
      Retrieves the named custom property of the specified process instance using the process instance ID.
      java.lang.String getCustomProperty(PIID piid, java.lang.String activityName, java.lang.String propertyName)
      Retrieves the named custom property of the specified activity instance using the process instance ID and the activity name.
      java.lang.String getCustomProperty(PTID ptid, java.lang.String propertyName)
      Retrieves the named custom property of the specified process template using the process template ID.
      java.lang.String getCustomProperty(java.lang.String identifier, java.lang.String propertyName)
      Retrieves the named custom property of the specified process template, process instance, or activity instance using a string representation of the object ID.
      java.lang.String getCustomProperty(java.lang.String piid, java.lang.String activityName, java.lang.String propertyValue)
      Retrieves the named custom property of the specified activity instance using a string representation of the process instance ID and the activity name.
      java.util.List getCustomPropertyInfo(int objectType, java.lang.String nameFilter, java.lang.Integer threshold)
      Retrieves information about custom properties of the specified object types.
      java.util.List getCustomPropertyNames(AIID aiid)
      Retrieves the custom property names of the specified activity instance using the activity instance ID.
      java.util.List getCustomPropertyNames(PIID piid)
      Retrieves the custom property names of the specified process instance using the process instance ID.
      java.util.List getCustomPropertyNames(PIID piid, java.lang.String activityName)
      Retrieves the custom property names of the specified activity instance using the process instance object ID and the activity instance name.
      java.util.List getCustomPropertyNames(PTID ptid)
      Retrieves the custom property names of the specified process template using the process template ID.
      java.util.List getCustomPropertyNames(java.lang.String identifier)
      Retrieves the custom property names of the specified process template, process instance, or activity instance using a string representation of the object ID.
      java.util.List getCustomPropertyNames(java.lang.String identifier, java.lang.String activityName)
      Retrieves the custom property names of the specified activity instance using a string representation of the process instance object ID and the activity instance name.
      ClientObjectWrapper getFaultMessage(AIID aiid)
      Retrieves the fault message of the specified activity instance using the activity instance ID.
      ClientObjectWrapper getFaultMessage(PIID piid)
      Retrieves the fault message of the specified process instance using the process instance ID.
      ClientObjectWrapper getFaultMessage(java.lang.String identifier)
      Retrieves the fault message of the specified process or activity instance using a string representation of the process or activity instance ID.
      java.util.List getFaultNames(AIID aiid)
      Retrieves the fault names defined for the specified activity instance using the activity instance ID.
      java.util.List getFaultNames(java.lang.String aiid)
      Retrieves the fault names defined for the specified activity instance using a string representation of the activity instance ID.
      byte[] getGraphics(PTID ptid)
      Retrieves a graphical representation of the specified process template using the process template ID.
      byte[] getGraphics(java.lang.String identifier)
      Retrieves a graphical representation of the specified process template using a string representation of the process template ID or the process template name.
      ClientObjectWrapper getInitialVariableValue(AIID aiid, java.lang.String variableName)
      Retrieves the initial value of the specified variable visible by the specified activity instance using the activity instance ID.
      ClientObjectWrapper getInitialVariableValue(PIID piid, java.lang.String variableName)
      Retrieves the initial value of the specified variable of the specified process instance using the process instance ID.
      ClientObjectWrapper getInitialVariableValue(PIID piid, java.lang.String activityName, java.lang.String variableName)
      Retrieves the initial value of the specified variable visible by the specified activity using the process instance ID and the activity name.
      ClientObjectWrapper getInitialVariableValue(java.lang.String identifier, java.lang.String variableName)
      Retrieves the initial value of the specified variable of the specified process instance or the specified variable visible by the specified activity instance using a string representation of the process or activity instance ID.
      ClientObjectWrapper getInitialVariableValue(java.lang.String piid, java.lang.String activityName, java.lang.String variableName)
      Retrieves the initial value of the specified variable visible by the specified activity using a string representation of the process instance ID and the activity name.
      InlineCustomProperty getInlineCustomProperty(PIID piid, java.lang.String propertyName)
      Retrieves the named inline custom property of the specified process instance using the process instance ID.
      InlineCustomProperty getInlineCustomProperty(PTID ptid, java.lang.String propertyName)
      Retrieves the named inline custom property of the specified process template using the process template ID.
      InlineCustomProperty getInlineCustomProperty(java.lang.String identifier, java.lang.String propertyName)
      Retrieves the named inline custom property of the specified process template or process instance using a string representation of the object ID.
      CustomClientSettings getInputClientUISettings(PIID piid)
      Retrieves client interface settings for the input message of the specified process instance using the process instance ID.
      CustomClientSettings getInputClientUISettings(java.lang.String piid)
      Retrieves client interface settings for the input message of the specified process instance using a string representation of the process instance ID.
      ClientObjectWrapper getInputMessage(AIID aiid)
      Retrieves the input message of the specified activity instance using the activity instance ID.
      ClientObjectWrapper getInputMessage(PIID piid)
      Retrieves the input message of the specified process instance using the process instance ID.
      ClientObjectWrapper getInputMessage(java.lang.String identifier)
      Retrieves the input message of the specified process or activity instance using a string representation of the ID.
      java.util.List getInputVariableNames(AIID aiid)
      Retrieves the names of all input variables for the specified activity instance using the activity instance ID.
      java.util.List getInputVariableNames(PIID piid, java.lang.String activityName)
      Retrieves the names of the input variables for the specified activity using the process instance ID and the activity name.
      java.util.List getInputVariableNames(java.lang.String aiid)
      Retrieves the names of all input variables for the specified activity instance using a string representation of the activity instance ID.
      java.util.List getInputVariableNames(java.lang.String piid, java.lang.String activityName)
      Retrieves the names of the input variables for the specified activity using a string representation of the process instance ID and the activity name.
      java.util.List getJumpTargetNames(AIID aiid)
      Retrieves the names of all activities that can be jumped to from the specified activity instance using the activity instance ID.
      java.util.List getJumpTargetNames(java.lang.String aiid)
      Retrieves the names of all activities that can be jumped to from the specified activity instance using a string representation of the activity instance ID.
      byte[] getMappingToGraphics(PTID ptid)
      Retrieves the descriptive information of the graphical representation of the specified process template using the process template ID.
      byte[] getMappingToGraphics(java.lang.String identifier)
      Retrieves the descriptive information of the graphical representation of the specified process template using a string representation of the process template ID or the process template name.
      java.lang.String getMessageTextOfException(java.util.Locale locale, java.lang.String messageKey, java.lang.Object[] variableValues)
      Retrieves the message text associated to the specified message key and locale.
      java.util.List getMigrationTargets(PTID ptid)
      Retrieves the object IDs of all process templates that can be migration targets for a process instance derived from the process template specified by the process template ID.
      java.util.List getMigrationTargets(java.lang.String ptid)
      Retrieves the object IDs of all process templates that can be migration targets for a process instance derived from the process template specified by a string representation of the process template ID.
      int getOperationMode()
      Indicates whether the Business Flow Manager database is used as an archive.
      LinkTemplateData[] getOutgoingLinks(AIID aiid)
      Retrieves information about the links starting at the specified activity instance using the activity instance ID.
      LinkTemplateData[] getOutgoingLinks(java.lang.String aiid)
      Retrieves information about the links starting at the specified activity instance using a string representation of the activity instance object ID.
      CustomClientSettings getOutputClientUISettings(PIID piid)
      Retrieves client interface settings for the output message of the specified process instance using the process instance ID.
      CustomClientSettings getOutputClientUISettings(java.lang.String piid)
      Retrieves client interface settings for the output message of the specified process instance using a string representation of the process instance ID.
      ClientObjectWrapper getOutputMessage(AIID aiid)
      Retrieves the output message of the specified activity instance using the activity instance ID.
      ClientObjectWrapper getOutputMessage(PIID piid)
      Retrieves the output message of the specified process instance using the process instance ID.
      ClientObjectWrapper getOutputMessage(java.lang.String identifier)
      Retrieves the output message of the specified process or activity instance using a string representation of the ID.
      java.util.List getOutputVariableNames(AIID aiid)
      Retrieves the names of all output variables for the specified activity instance using the activity instance ID.
      java.util.List getOutputVariableNames(PIID piid, java.lang.String activityName)
      Retrieves the names of the output variables for the specified activity using the process instance ID and the activity name.
      java.util.List getOutputVariableNames(java.lang.String identifier)
      Retrieves the names of all output variables for the specified activity instance using a string representation of the activity instance ID.
      java.util.List getOutputVariableNames(java.lang.String piid, java.lang.String activityName)
      Retrieves the names of the output variables for the specified activity using a string representation of the process instance ID and the activity name.
      TKIID getParticipatingTaskID(AIID aiid)
      Retrieves the object ID of the task instance associated to the specified human task activity using the activity instance ID.
      TKIID getParticipatingTaskID(java.lang.String aiid)
      Retrieves the object ID of the task instance associated to the specified human task activity using a string representation of the activity instance ID.
      ProcessInstanceData getProcessInstance(PIID piid)
      Retrieves the specified process instance using the process instance ID.
      ProcessInstanceData getProcessInstance(java.lang.String identifier)
      Retrieves the specified process instance using a string representation of the process instance ID or the process instance name.
      ProcessTemplateData getProcessTemplate(PTID ptid)
      Retrieves the specified process template using the process template ID.
      ProcessTemplateData getProcessTemplate(java.lang.String identifier)
      Retrieves the specified process template using a string representation of the process template ID or the process template name.
      java.util.List getQueryProperties(PTID ptid)
      Retrieves the query properties of the specified process template using the process template ID.
      java.util.List getQueryProperties(java.lang.String identifier)
      Retrieves the query properties of the specified process template using a string representation of the process template ID or the process template name.
      QueryTableMetaData getQueryTableMetaData(java.lang.String queryTableName, java.util.Locale locale)
      Returns the meta data of the specified query table.
      ActivityServiceTemplateData[] getStartActivities(PTID ptid)
      Retrieves information about activities that can start a process instance from the specified process template using the process template ID.
      ActivityServiceTemplateData[] getStartActivities(java.lang.String ptid)
      Retrieves information about activities that can start a process instance from the specified process template using a string representation of the process template ID.
      StoredQueryData getStoredQuery(int kind, java.lang.String storedQueryName)
      Retrieves the specified private or public stored query definition.
      StoredQueryData getStoredQuery(java.lang.String storedQueryName)
      Retrieves the specified stored query definition.
      StoredQueryData getStoredQuery(java.lang.String userID, java.lang.String storedQueryName)
      Retrieves the specified stored query definition for the specified user.
      java.lang.String[] getStoredQueryNames()
      Retrieves the names of stored queries persistently stored in the database.
      java.lang.String[] getStoredQueryNames(int kind)
      Retrieves the names of private or public stored queries that are persistently stored in the database.
      java.lang.String[] getStoredQueryNames(java.lang.String userID)
      Retrieves the names of stored queries that are persistently stored in the database for the specified user.
      StaffResultSet getUsersInRole(AIID aiid, int role)
      Retrieves the users that are members of the specified role for the specified activity instance using the activity instance ID.
      StaffResultSet getUsersInRole(PIID piid, int role)
      Retrieves the users that are members of the specified role for the specified process instance using the process instance ID.
      StaffResultSet getUsersInRole(java.lang.String identifier, int role)
      Retrieves the users that are members of the specified role for the specified process or activity instance using string representations of the object IDs.
      ClientObjectWrapper getVariable(AIID aiid, java.lang.String variableName)
      Retrieves the specified variable visible by the specified activity instance using the activity instance ID.
      ClientObjectWrapper getVariable(PIID piid, java.lang.String variableName)
      Retrieves the specified variable of the specified process instance using the process instance ID.
      ClientObjectWrapper getVariable(PIID piid, java.lang.String activityName, java.lang.String variableName)
      Retrieves the specified variable visible by the specified activity using the process instance ID and the activity name.
      ClientObjectWrapper getVariable(java.lang.String identifier, java.lang.String variableName)
      Retrieves the specified variable of the specified process instance or the specified variable visible by the specified activity instance using a string representation of the process or activity instance ID.
      ClientObjectWrapper getVariable(java.lang.String piid, java.lang.String activityName, java.lang.String variableName)
      Retrieves the specified variable visible by the specified activity using a string representation of the process instance ID and the activity name.
      java.util.List getVariableNames(AIID aiid)
      Retrieves the names of all variables for the specified activity instance using the activity instance ID.
      java.util.List getVariableNames(EHTID ehtid)
      Retrieves the names of all variables for the event handler template using the event handler template ID.
      java.util.List getVariableNames(PIID piid, java.lang.String activityName)
      Retrieves the names of the variables of the specified activity using the process instance ID and the activity name.
      java.util.List getVariableNames(java.lang.String identifier)
      Retrieves the names of the variables of the specified event handler template or activity instance using a string representation of the event handler template ID or activity instance ID.
      java.util.List getVariableNames(java.lang.String piid, java.lang.String activityName)
      Retrieves the names of the variables of the specified activity using a string representation of the process instance ID and the activity name.
      ActivityServiceTemplateData[] getWaitingActivities(PIID piid)
      Retrieves information about activities of a process instance, that are in the waiting execution state.
      ActivityServiceTemplateData[] getWaitingActivities(java.lang.String piid)
      Retrieves information about activities of a process instance, that are in the waiting execution state.
      WorkItemData[] getWorkItems(AIID aiid)
      Retrieves work item assignments for the logged-on user and the specified activity instance using the activity instance ID.
      WorkItemData[] getWorkItems(PIID piid)
      Retrieves work item assignments for the logged-on user and the specified process instance using the process instance ID.
      WorkItemData[] getWorkItems(java.lang.String identifier)
      Retrieves work item assignments for the logged-on user and a process or activity instance using a string representation of the process or activity instance ID.
      WorkListData getWorkList(java.lang.String workListName)
      Deprecated. 
      As of version 6.0, replaced by getStoredQuery.
      int[] getWorkListActions()
      Deprecated. 
      As of version 6.0.2, no replacement.

      java.lang.String[] getWorkListNames()
      Deprecated. 
      As of version 6.0, replaced by getStoredQueryNames.

      void initializeCorrelationSet(PIID piid, CorrelationSetInstanceData correlationSetInstance)
      Initializes the specified correlation set instance using the process instance ID.
      void initializeCorrelationSet(java.lang.String piid, CorrelationSetInstanceData correlationSetInstance)
      Initializes the specified correlation set instance using a string representation of the process instance ID.
      PIID initiate(java.lang.String processTemplateName, ClientObjectWrapper inputMessage)
      Creates a process instance from the specified process template, passes the specified input message, and initiates processing of the process instance.
      PIID initiate(java.lang.String processTemplateName, java.lang.String processInstanceName, ClientObjectWrapper inputMessage)
      Creates a named process instance from the specified process template, passes the specified input message, and initiates processing of the process instance.
      PIID initiate(java.lang.String vtid, java.lang.String atid, java.lang.String processInstanceName, ClientObjectWrapper inputMessage)
      Creates a named process instance identifying the starting service by a string representation of its ID, passes the specified input message, and initiates processing of the process instance.
      PIID initiate(VTID vtid, ATID atid, java.lang.String processInstanceName, ClientObjectWrapper inputMessage)
      Creates a named process instance identifying the starting service by its ID, passes the specified input message, and initiates processing of the process instance.
      InitiateAndClaimFirstResult initiateAndClaimFirst(java.lang.String processTemplateName, java.lang.String processInstanceName, ClientObjectWrapper inputMessage)
      Creates a process instance from the specified process template and claims the first inline human task for the logged-on user.
      InitiateAndClaimFirstResult initiateAndClaimFirst(java.lang.String vtid, java.lang.String atid, java.lang.String processInstanceName, ClientObjectWrapper inputMessage)
      Creates and executes a process instance using string representations of object IDs identifying a starting activity service template, and claims the first inline human task for the logged-on user.
      InitiateAndClaimFirstResult initiateAndClaimFirst(java.lang.String processTemplateName, java.lang.String vtid, java.lang.String atid, java.lang.String processInstanceName, ClientObjectWrapper inputMessage)
      Deprecated. 
      As of version 7.5, replaced by initiateAndClaimFirst.
      InitiateAndClaimFirstResult initiateAndClaimFirst(java.lang.String processTemplateName, java.lang.String nameSpace, java.lang.String portType, java.lang.String operation, java.lang.String processInstanceName, ClientObjectWrapper inputMessage)
      Creates a process instance from the specified process template by calling the specified starting service, and claims the first inline human task for the logged-on user.
      InitiateAndClaimFirstResult initiateAndClaimFirst(java.lang.String processTemplateName, VTID vtid, ATID atid, java.lang.String processInstanceName, ClientObjectWrapper inputMessage)
      Deprecated. 
      As of version 7.5, replaced by initiateAndClaimFirst.
      InitiateAndClaimFirstResult initiateAndClaimFirst(VTID vtid, ATID atid, java.lang.String processInstanceName, ClientObjectWrapper inputMessage)
      Creates and executes a process instance using object IDs identifying a starting activity service template, and claims the first inline human task for the logged-on user.
      PIID initiateAndSuspend(java.lang.String processTemplateName, java.lang.String processInstanceName, ClientObjectWrapper inputMessage)
      Creates a process instance from the specified process template and immediately suspends navigation of the process instance.
      PIID initiateAndSuspend(java.lang.String vtid, java.lang.String atid, java.lang.String processInstanceName, ClientObjectWrapper inputMessage)
      Creates a process instance by calling the specified starting service identified by string representations of its object IDs, and immediately suspends navigation of the process instance.
      PIID initiateAndSuspend(java.lang.String processTemplateName, java.lang.String nameSpace, java.lang.String portType, java.lang.String operation, java.lang.String processInstanceName, ClientObjectWrapper inputMessage)
      Creates a process instance from the specified process template by calling the specified starting service, and immediately suspends navigation of the process instance.
      PIID initiateAndSuspend(VTID vtid, ATID atid, java.lang.String processInstanceName, ClientObjectWrapper inputMessage)
      Creates a process instance by calling the specified starting service identified by its object IDs, and immediately suspends navigation of the process instance.
      boolean isBusinessProcessAdministrator()
      Indicates whether the logged-on user is a business process administrator (system administrator).
      boolean isBusinessProcessMonitor()
      Indicates whether the logged-on user is a business process monitor (system monitor).
      void jump(AIID aiid, java.lang.String targetActivityName)
      Jumps from an activity instance identified by the activity instance ID to the specified target activity.
      void jump(java.lang.String aiid, java.lang.String targetActivityName)
      Jumps from an activity instance identified by a string representation of the activity instance ID to the specified target activity.
      ProcessInstanceData migrate(PIID piid, PTID ptid)
      Migrates the process instance identified by the process instance ID to an instance of the specified process template.
      ProcessInstanceData migrate(java.lang.String piid, java.lang.String ptid)
      Migrates the process instance identified by a string representation of the process instance ID to an instance of the specified process template.
      void newWorkList(java.lang.String workListName, java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer threshold, java.util.TimeZone timeZone)
      Deprecated. 
      As of version 6.0, replaced by createStoredQuery.
      QueryResultSet query(int kind, java.lang.String storedQueryName, java.lang.Integer skipTuples, java.lang.Integer threshold, java.util.List parameters)
      Performs the specified public or private stored query.
      QueryResultSet query(java.lang.String storedQueryName, java.lang.Integer skipTuples)
      Deprecated. 
      QueryResultSet query(java.lang.String storedQueryName, java.lang.Integer skipTuples, java.lang.Integer threshold)
      QueryResultSet query(java.lang.String storedQueryName, java.lang.Integer skipTuples, java.lang.Integer threshold, java.util.List parameters)
      Performs the specified stored query and specifies values for parameters in the where-clause.
      QueryResultSet query(java.lang.String storedQueryName, java.lang.Integer skipTuples, java.util.List parameters)
      Performs the specified stored query, specifies values for the parameters in the where-clause, and returns the qualifying object properties.
      QueryResultSet query(java.lang.String userID, java.lang.String storedQueryName, java.lang.Integer skipTuples, java.lang.Integer threshold, java.util.List parameters)
      Performs the specified private stored query of the specified user.
      QueryResultSet query(java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer skipTuples, java.lang.Integer threshold, java.util.TimeZone timeZone)
      Retrieves selected object properties persistently stored in the database and allows for retrieving a specified set of data only.
      QueryResultSet query(java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer threshold, java.util.TimeZone timeZone)
      Retrieves selected object properties persistently stored in the database.
      QueryResultSet queryAll(java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer skipTuples, java.lang.Integer threshold, java.util.TimeZone timeZone)
      Retrieves selected object properties of all objects persistently stored in the database and allows for retrieving a specified set of data only.
      EntityResultSet queryEntities(java.lang.String queryTableName, FilterOptions filterOptions, AuthorizationOptions authorizationOptions, java.util.List parameters)
      Queries entities using the specified query table.
      int queryEntityCount(java.lang.String queryTableName, FilterOptions filterOptions, AuthorizationOptions authorizationOptions, java.util.List parameters)
      Counts qualifying entities of a potential query for entities.
      ProcessTemplateData[] queryProcessTemplates(java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer threshold, java.util.TimeZone timeZone)
      Retrieves process templates persistently stored in the database.
      int queryRowCount(java.lang.String queryTableName, FilterOptions filterOptions, AuthorizationOptions authorizationOptions, java.util.List parameters)
      Counts qualifying objects of a potential query table query.
      RowResultSet queryRows(java.lang.String queryTableName, FilterOptions filterOptions, AuthorizationOptions authorizationOptions, java.util.List parameters)
      Queries attributes using the specified query table.
      void rescheduleTimer(AIID aiid, TimerSpecification timerSpecification)
      Reschedules timers of the specified active activity instance using the activity instance ID and a timer specification.
      void rescheduleTimer(java.lang.String aiid, TimerSpecification timerSpecification)
      Reschedules timers of the specified active activity instance using a string representation of the activity instance ID and a timer specification.
      void restart(PIID piid)
      Restarts the specified top-level process instance and its non-autonomous subprocesses using the process instance ID.
      void restart(java.lang.String piid)
      Restarts the specified top-level process instance and its non-autonomous subprocesses using the process instance ID.
      void resume(PIID piid)
      Resumes the specified top-level process instance and its non-autonomous subprocesses using the process instance ID.
      void resume(java.lang.String piid)
      Resumes the specified top-level process instance and its non-autonomous subprocesses using a string representation of the process instance ID.
      void sendMessage(PIID piid, VTID vtid, ATID atid, ClientObjectWrapper message)
      Sends the specified message to the specified activity service and process instance using the process instance, activity service template, and activity template IDs.
      PIID sendMessage(PTID ptid, java.lang.String nameSpace, java.lang.String portType, java.lang.String operation, ClientObjectWrapper message)
      Sends the specified message to the specified process template using the process template ID and the namespace, port type, and operation of the service to be called.
      PIID sendMessage(java.lang.String vtid, java.lang.String atid, ClientObjectWrapper message)
      Sends the specified message to the specified activity service using a string representation of the activity service template ID and the activity template ID.
      void sendMessage(java.lang.String piid, java.lang.String vtid, java.lang.String atid, ClientObjectWrapper message)
      Sends the specified message to the specified activity service and process instance using a string representation of the process instance, activity service template, and activity template IDs.
      PIID sendMessage(java.lang.String processTemplateName, java.lang.String nameSpace, java.lang.String portType, java.lang.String operation, ClientObjectWrapper message)
      Sends the specified message to the specified process template using the namespace, port type, and operation of the service to be called.
      void sendMessage(java.lang.String processTemplateName, java.lang.String nameSpace, java.lang.String portType, java.lang.String operation, ClientObjectWrapper message, ReplyContextWrapper replyContext)
      Sends the specified message to the specified process template, using the namespace, port type, and operation of the service to be called and returns the result of operation.
      void sendMessage(java.lang.String processTemplateName, java.lang.String nameSpace, java.lang.String portType, java.lang.String operation, ClientObjectWrapper message, ReplyContextWrapper replyContext, int invocationCount, java.lang.String requestId)
      Sends the specified message to the specified process template, using the namespace, port type, and operation of the service to be called and returns the result of operation, in case of errors trying multiple times.
      PIID sendMessage(VTID vtid, ATID atid, ClientObjectWrapper message)
      Sends the specified message to the specified activity service using the activity service template ID and the activity template ID.
      void setBinaryCustomProperty(AIID aiid, BinaryCustomProperty property)
      Stores custom-specific binary values for the specified activity instance using the activity instance ID.
      void setBinaryCustomProperty(PIID piid, BinaryCustomProperty property)
      Stores custom-specific binary values for the specified process instance using the process instance ID.
      void setBinaryCustomProperty(PIID piid, java.lang.String activityName, BinaryCustomProperty property)
      Stores custom-specific binary values for the specified activity instance using the process instance ID and the activity name.
      void setBinaryCustomProperty(java.lang.String identifier, BinaryCustomProperty property)
      Stores custom-specific binary values for the specified process or activity instance using a string representation of the process or activity instance ID.
      void setBinaryCustomProperty(java.lang.String piid, java.lang.String activityName, BinaryCustomProperty property)
      Stores custom-specific binary values for the specified activity instance using a string representation of the process instance ID and the activity name.
      void setCustomProperty(AIID aiid, java.lang.String propertyName, java.lang.String propertyValue)
      Stores custom-specific values for the specified activity instance using the activity instance ID.
      void setCustomProperty(PIID piid, java.lang.String propertyName, java.lang.String propertyValue)
      Stores custom specific values for the specified process instance using the process instance ID.
      void setCustomProperty(PIID piid, java.lang.String activityName, java.lang.String propertyName, java.lang.String propertyValue)
      Stores custom-specific values for the specified activity instance using the process instance ID and the activity name.
      void setCustomProperty(java.lang.String identifier, java.lang.String propertyName, java.lang.String propertyValue)
      Stores custom-specific values for the specified process or activity instance using a string representation of the object ID.
      void setCustomProperty(java.lang.String identifier, java.lang.String activityName, java.lang.String propertyName, java.lang.String propertyValue)
      Stores custom-specific values for the specified activity instance using a string representation of the process instance and the activity instance name.
      void setFaultMessage(AIID aiid, java.lang.String faultName, ClientObjectWrapper faultMessage)
      Stores the specified fault message for the specified activity instance into the database using the activity instance ID.
      void setFaultMessage(java.lang.String aiid, java.lang.String faultName, ClientObjectWrapper faultMessage)
      Stores the specified fault message for the specified activity instance into the database using a string representation of the activity instance ID.
      void setInlineCustomProperties(PIID piid, java.util.List customProperties)
      Stores custom-specific values for the specified process instance using the process instance ID.
      void setInlineCustomProperties(java.lang.String piid, java.util.List customProperties)
      Stores custom-specific values for the specified process instance using a string representation of the process instance ID.
      java.util.List setInlineCustomProperty(PIID[] piids, InlineCustomProperty property)
      Stores custom-specific values for the specified process instances using process instance IDs.
      void setInlineCustomProperty(PIID piid, InlineCustomProperty property)
      Stores custom specific values for the specified process instance using the process instance ID.
      java.util.List setInlineCustomProperty(java.lang.String[] piids, InlineCustomProperty property)
      Stores custom-specific values for the specified proeess instances using string representations of the process instance IDs.
      void setInlineCustomProperty(java.lang.String piid, InlineCustomProperty property)
      Stores custom-specific values for the specified process instance using a string representation of the process instance ID.
      void setOutputMessage(AIID aiid, ClientObjectWrapper outputMessage)
      Stores the output message of the specified activity instance into the database using the activity instance ID.
      void setOutputMessage(java.lang.String aiid, ClientObjectWrapper outputMessage)
      Stores the output message of the specified activity instance into the database using a string representation of the activity instance ID.
      void setVariable(AIID aiid, java.lang.String variableName, ClientObjectWrapper message)
      Sets the specified variable visible by the activity instance using the variable name and the associated activity instance ID.
      void setVariable(PIID piid, java.lang.String variableName, ClientObjectWrapper message)
      Sets the specified variable using the variable name and the associated process instance ID.
      void setVariable(PIID piid, java.lang.String activityName, java.lang.String variableName, ClientObjectWrapper message)
      Sets the specified variable visible by the activity using the process instance ID and the activity and variable names.
      void setVariable(java.lang.String identifier, java.lang.String variableName, ClientObjectWrapper message)
      Sets the specified variable using the variable name and a string representation of the associated process or activity instance ID.
      void setVariable(java.lang.String piid, java.lang.String activityName, java.lang.String variableName, ClientObjectWrapper message)
      Sets the specified variable visible by the activity using a string representation of the process instance ID and the activity and variable names.
      void skip(AIID aiid)
      Skips the activity instance using the activity instance ID.
      void skip(PIID piid, java.lang.String activityName)
      Skips the specified activity instance using the associated process instance ID and the activity instance name.
      void skip(java.lang.String aiid)
      Skips the activity instance using a string representation of the activity instance ID.
      void skip(java.lang.String piid, java.lang.String activityName)
      Skips the specified activity instance using a string representation of the associated process instance ID and the activity name.
      void skipAndJump(AIID aiid, java.lang.String targetActivityName)
      Skips the activity instance using the activity instance ID and continues navigation at the specified target activity.
      void skipAndJump(java.lang.String aiid, java.lang.String targetActivityName)
      Skips the activity instance using a string representation of the activity instance ID and continues navigation at the specified target activity.
      void suspend(PIID piid)
      Suspends the specified top-level process instance and its non-autonomous subprocesses using the process instance ID.
      void suspend(PIID piid, java.util.Calendar deadline)
      Suspends the specified top-level process instance and its non-autonomous subprocesses until the specified point in time is reached using the process instance ID.
      void suspend(PIID piid, int duration)
      Suspends the specified top-level process instance and its non-autonomous subprocesses for the specified duration using the process instance ID.
      void suspend(PIID piid, java.lang.String timeoutExpression, java.lang.String calendarName, java.lang.String JNDINameOfCalendar)
      Suspends the specified top-level process instance and its non-autonomous subprocesses for a calendar specific time using the process instance ID.
      void suspend(java.lang.String piid)
      Suspends the specified top-level process instance and its non-autonomous subprocesses using a string representation of the process instance ID.
      void suspend(java.lang.String piid, java.util.Calendar deadline)
      Suspends the specified top-level process instance and its non-autonomous subprocesses until the specified point in time is reached using a string representation of the process instance ID.
      void suspend(java.lang.String piid, int duration)
      Suspends the specified top-level process instance and its non-autonomous subprocesses for the specified duration using a string representation of the process instance ID.
      void suspend(java.lang.String piid, java.lang.String timeoutExpression, java.lang.String calendarName, java.lang.String JNDINameOfCalendar)
      Suspends the specified top-level process instance and its non-autonomous subprocesses for a calendar specific time using a string representation of the process instance ID.
      boolean testMigration(PIID piid, PTID ptid)
      Checks whether the process instance identified by the process instance ID can be migrated to an instance of the specified process template.
      boolean testMigration(java.lang.String piid, java.lang.String ptid)
      Checks whether the process instance identified by a string representation of the process instance ID can be migrated to an instance of the specified process template.
      void transferWorkItem(AIID aiid, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner)
      Transfers the specified work item for the specified activity instance using the activity instance ID.
      void transferWorkItem(PIID piid, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner)
      Transfers the specified work item for the specified process instance using the process instance ID.
      void transferWorkItem(java.lang.String identifier, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner)
      Transfers the specified work item for a process or activity instance using a string representation of either the process or activity instance ID.
      void uninitializeCorrelationSet(PIID piid, java.lang.String correlationSetName)
      Uninitializes the specified correlation set instance using the process instance ID and the correlation set name.
      void uninitializeCorrelationSet(java.lang.String piid, java.lang.String correlationSetName)
      Uninitializes the specified correlation set instance using a string representation of the process instance ID and the correlation set name.
      • Methods inherited from interface javax.ejb.EJBObject

        getEJBHome, getHandle, getPrimaryKey, isIdentical, remove
IBM Business Process ManagerTM
Release 8