com.ibm.bpe.api
Interface BusinessFlowManager

All Superinterfaces:
BusinessFlowManagerService, javax.ejb.EJBObject, java.rmi.Remote

public interface BusinessFlowManager
extends javax.ejb.EJBObject, BusinessFlowManagerService

BusinessFlowManager is the stateless session bean that represents the remote interface. See BusinessFlowManagerService for detailed method descriptions.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 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(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(java.lang.String aiid)
          Cancels the claim of an activity instance using a string representation of the activity instance ID.
 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 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.
 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.
 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 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 subprocesses using the process instance ID.
 void delete(java.lang.String piid)
          Deletes the specified top-level process instance and its subprocesses using a string representation of the process instance ID.
 void deleteStoredQuery(java.lang.String storedQueryName)
          Deletes the specified stored query.
 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. WorkList has been renamed to StoredQuery. Use deleteStoredQuery(.
 QueryResultSet executeWorkList(java.lang.String workListName)
          Deprecated. WorkList has been renamed to StoredQuery. Use query().
 void forceComplete(AIID aiid, boolean continueOnError)
          Forces the completion of a stopped activity instance using the activity instance ID.
 void forceComplete(AIID aiid, ClientObjectWrapper output, boolean continueOnError)
          Forces the completion of a stopped 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 a stopped 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 a stopped 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 a stopped 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 a stopped activity instance using a string representation of the activity instance ID and states the actual result of user processing.
 void forceRetry(AIID aiid, boolean continueOnError)
          Forces the repetition of a stopped activity instance using the activity instance ID.
 void forceRetry(AIID aiid, ClientObjectWrapper inputMessage, boolean continueOnError)
          Forces the repetition of a stopped activity instance using the activity instance ID and an input message.
 void forceRetry(java.lang.String aiid, boolean continueOnError)
          Forces the repetition of a stopped activity instance using a string representation of the activity instance ID.
 void forceRetry(java.lang.String aiid, ClientObjectWrapper inputMessage, boolean continueOnError)
          Forces the repetition of a stopped activity instance using a string representation of the activity instance ID and an input message.
 void forceTerminate(PIID piid)
          Terminates the specified top-level process instance, its 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 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 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 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.
 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.
 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 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(java.lang.String identifier)
          Retrieves the custom properties of the specified process instance or activity instance using a string representation of the object ID.
 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(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.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(java.lang.String identifier)
          Retrieves the custom property names of the specified process instance or activity instance using a string representation of the object ID.
 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.
 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.
 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.
 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.
 ActivityServiceTemplateData[] getStartActivities(PTID ptid)
          Returns 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)
          Returns 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(java.lang.String storedQueryName)
          Retrieves the specified stored query definition.
 java.lang.String[] getStoredQueryNames()
          Retrieves the names of stored queries persistently stored in the database.
 ClientObjectWrapper getVariable(AIID aiid, java.lang.String variableName)
          Retrieves the specified variable of the scope visible in 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(java.lang.String identifier, java.lang.String variableName)
          Retrieves the specified variable of the specified process instance or the specified variable visible in the scope of the specified activity instance using a string representation of the process or activity instance ID.
 ActivityServiceTemplateData[] getWaitingActivities(PIID piid)
          Returns information about activities of a process instance, that are in the waiting execution state.
 ActivityServiceTemplateData[] getWaitingActivities(java.lang.String piid)
          Returns 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. WorkList has been renamed to StoredQuery. Use getStoredQuery(.
 int[] getWorkListActions()
          Deprecated. 

 java.lang.String[] getWorkListNames()
          Deprecated. WorkList has been renamed to StoredQuery. Use getStoredQueryNames(.

 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.
 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 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. WorkList has been renamed to StoredQuery. Use createStoredQuery(.
 QueryResultSet query(java.lang.String storedQueryName, java.lang.Integer skipTuples)
          Executes the stored query and returns the qualifying object properties.
 QueryResultSet query(java.lang.String storedQueryName, java.lang.Integer skipTuples, java.lang.Integer threshold)
          Executes the stored query and returns the qualifying object properties.
 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.
 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.
 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.
 void restart(PIID piid)
          Restarts the specified top-level process instance and its subprocesses using the process instance ID.
 void restart(java.lang.String piid)
          Restarts the specified top-level process instance and its subprocesses using the process instance ID.
 void resume(PIID piid)
          Resumes the specified top-level process instance and its subprocesses using the process instance ID.
 void resume(java.lang.String piid)
          Resumes the specified top-level process instance and its 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(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.
 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.
 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.
 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 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(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 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 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 in the scope visible for this activity 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(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 suspend(PIID piid)
          Suspends the specified top-level process instance and its subprocesses using the process instance ID.
 void suspend(java.lang.String piid)
          Suspends the specified top-level process instance and its subprocesses using a string representation of the process instance ID.
 void transferWorkItem(AIID aiid, int assignmentReason, java.lang.String fromUserID, java.lang.String toUserID)
          Transfers a work item for the specified activity instance to the specified user using the activity instance ID.
 void transferWorkItem(PIID piid, int assignmentReason, java.lang.String fromUserID, java.lang.String toUserID)
          Transfers a work item for the specified process instance to the specified user using the process instance ID.
 void transferWorkItem(java.lang.String identifier, int assignmentReason, java.lang.String fromUserID, java.lang.String toUserID)
          Transfers the specified work item for a process or activity instance to the specified user, using a string representation of either the process or activity instance ID.
 
Methods inherited from interface javax.ejb.EJBObject
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

queryProcessTemplates

public ProcessTemplateData[] queryProcessTemplates(java.lang.String whereClause,
                                                   java.lang.String orderByClause,
                                                   java.lang.Integer threshold,
                                                   java.util.TimeZone timeZone)
                                            throws IdWrongFormatException,
                                                   InvalidLengthException,
                                                   ObjectDoesNotExistException,
                                                   QueryInvalidOperandException,
                                                   QueryInvalidTimestampException,
                                                   QueryUndefinedParameterException,
                                                   QueryUnknownColumnException,
                                                   QueryUnknownOperatorException,
                                                   QueryUnknownTableException,
                                                   UnexpectedFailureException,
                                                   java.rmi.RemoteException,
                                                   javax.ejb.EJBException
Retrieves process templates persistently stored in the database.

You can specify a threshold or a filter to reduce the number of process templates returned. If the number is not restricted, all process templates you are authorized to see are returned. Process templates are only returned if the enterprise application they belong to is not stopped.

Process templates are sorted on the server according to the specified sort criteria.

The parameters of the query, the where- and order-by-clause, are specified using SQL based on the PROCESS_TEMPLATE view. Execution of the query can thus be shifted to SQL and becomes portable and optimizable.

Specified by:
queryProcessTemplates in interface BusinessFlowManagerService
Parameters:
whereClause - The search condition to be applied to the set of available templates. Its syntax is an SQL where-clause. The following rules apply:
  • Specify object ID constants as ID('string-rep-of-ptid').
  • Specify timestamp constants as TS('yyyy-mm-ddThh:mm:ss') or as CURRENT_DATE for comparisons with the current date.
    The date and time parts of a TS definition are optional; either the date or the time must be specified. If no date part of a TS definition is specified, the current date is taken. Optional time values that are not specified are set to zero. The timestamp is 24 hours based. For example, TS('16:04') is the same as TS('2002-12-24T16:04:00') provided that the current date is December 24th, 2002.
    If a date part of a TS definition is specified, the year must consist of 4 letters; the month and day specifications are optional. Missing month and day specifications are set to 01. For example, specifying TS('2003') is the same as specifying TS('2003-01-01T00:00:00').
  • Specify binary constants as BIN('UTF-8 string').
  • Use constants instead of integer enumerations. For example, instead of specifying a process template state expression "PROCESS_TEMPLATE.STATE=2" specify "PROCESS_TEMPLATE.STATE=PROCESS_TEMPLATE.STATE.STATE_STOPPED".
  • Duplicate apostrophes (') in comparising values. For example, "PROCESS_TEMPLATE.NAME='d''automatisation'".

If a filter is not to be applied, null must be specified.

orderByClause - Sorts the qualifying process templates by the values of the columns specified. Its syntax is an SQL order-by-clause. Each comma separated part of the order-by-clause must specify a property from the PROCESS_TEMPLATE view.

If you specify more than one column, the process templates are ordered by the values of the first column specified, then by the values of the second column, and so on.

If the process templates are not to be sorted, null must be specified.

Note that sort criteria are applied on the server, that is, the locale of the server is used for sorting.

threshold - Specifies the maximum number of process templates to be returned from the server to the client. If a threshold is not to be applied, null must be specified.
timeZone - The time zone of the timestamp constants in the whereClause. If a timezone is not specified, UTC is assumed.

Returns:
ProcessTemplateData[] - An array of qualifying process templates. If no templates qualify, an empty array is returned. Refer to ProcessTemplateData to view the process template properties.

Throws:
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
QueryInvalidOperandException
QueryInvalidTimestampException
QueryUndefinedParameterException
QueryUnknownColumnException
QueryUnknownOperatorException
QueryUnknownTableException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

query

public QueryResultSet query(java.lang.String selectClause,
                            java.lang.String whereClause,
                            java.lang.String orderByClause,
                            java.lang.Integer threshold,
                            java.util.TimeZone timeZone)
                     throws WorkItemManagerException,
                            UnexpectedFailureException,
                            java.rmi.RemoteException,
                            javax.ejb.EJBException
Retrieves selected object properties persistently stored in the database.

You can specify a filter or a threshold to restrict the number of tuples returned. The tuples are sorted on the server according to the specified sort criteria.

Specify the parameters of the query, the select-, where-, and order-by-clause, using SQL based on the published process views. Execution of the query can thus be shifted to SQL and becomes portable and optimizable.

The domain of the query, that is, the SQL from-clause, is determined automatically. In principle, all properties of objects are selectable for which you own a work item, that is, which can be transitively reached via a user's work item. As a rule of thumb, all objects except process templates can be reached via work items.

The business process administrator has special rights and can access all objects, included process templates, that is, the business process administrator is the only user who can use properties of the PROCESS_TEMPLATE view only. All other users must specify a non process template property in the select- or where-clause.

Specified by:
query in interface BusinessFlowManagerService
Parameters:
selectClause - Describes the query result, that is, declares a list of names that identify the object properties (columns of the result) to be returned. Its syntax is an SQL select-clause. Aggregation functions like AVG(), SUM(), MIN(), and MAX() are not supported. Each comma separated part of the select-clause must specify a property from the published process views - see the InfoCenter for details.

To select properties of name-value pairs like custom properties, add a one-digit suffix (0-9) to the view name. For example, "ACTIVITY_ATTRIBUTE1.VALUE, ACTIVITY_ATTRIBUTE2.VALUE".

To count the number of potentially qualifying tuples, use the COUNT keyword. For example, to count the number of activity instance IDs that satisfy the where-clause, specify a select-clause such as "COUNT(DISTINCT ACTIVITY.AIID)". If you use the more generic "COUNT(*)", then you must specify a where-clause so that the tuples to be counted can be determined. For example, to count all activities, specify a where-clause such as "ACTIVITY.AIID=ACTIVITY.AIID" that always evaluates to true.

The QueryResultSet contains columns in the same order as specified in the selectClause. If tuples are to be counted, an int value is returned (row 1, column 1).

whereClause - The search condition to be applied to the query domain. Its syntax is an SQL where-clause. The following rules apply:
  • Specify object ID constants as ID('string-rep-of-oid').
  • Specify timestamp constants as TS('yyyy-mm-ddThh:mm:ss') or as CURRENT_DATE for comparisons with the current date.
    The date and time parts of a TS definition are optional; either the date or the time must be specified. If no date part of a TS definition is specified, the current date is taken. Optional time values that are not specified are set to zero. The timestamp is 24 hours based. For example, TS('16:04') is the same as TS('2002-12-24T16:04:00') provided that the current date is December 24th, 2002.
    If a date part of a TS definition is specified, the year must consist of 4 letters; the month and day specifications are optional. Missing month and day specifications are set to 01. For example, specifying TS('2003') is the same as specifying TS('2003-01-01T00:00:00').
  • Specify binary constants as BIN('UTF-8 string').
  • Use constants instead of integer enumerations. For example, instead of specifying an activity state expression "ACTIVITY.STATE=2" , specify "ACTIVITY.STATE=ACTIVITY.STATE.STATE_READY".
  • Duplicate apostrophes (') in comparising values. For example, "ACTIVITY.NAME='d''automatisation'".
  • To specify a where clause that refers to properties of name-value pairs, like custom properties, add a one-digit suffix (0-9) to the view name.
    For example, to have only tuples returned where an activity custom property "prop1" has the value "v1" or where an activity custom property "prop2" has the value v2", the where clause can look like "ACTIVITY_ATTRIBUTE1.NAME='prop1' AND ACTIVITY_ATTRIBUTE1.VALUE='v1' OR ACTIVITY_ATTRIBUTE2.NAME='prop2' AND ACTIVITY_ATTRIBUTE2.VALUE = 'v2'". For performance reasons, you should not use more than one "OR" construct; use "IN" instead.
    For example, to retrieve the values of custom properties "prop1" and "prop2" of all activity instances, the select clause can look like "DISTINCT ACTIVITY.AIID, ACTIVITY_ATTRIBUTE1.VALUE, ACTIVITY_ATTRIBUTE2.VALUE" and the where-clause "ACTIVITY_ATTRIBUTE1.NAME = 'prop1' AND ACTIVITY_ATTRIBUTE2.NAME = 'prop2'".

If a filter is not to be applied, null must be specified.

orderByClause - Sorts the query result set by the values of the columns you identify. Its syntax is an SQL order-by-clause. Each comma separated part of the order-by-clause must specify a property from the published process views - see the InfoCenter for details.

If you identify more that one property, the query result set is ordered by the values of the first property you identify, then by the values of the second property, and so on.

If sort criteria are not to be applied, null must be specified.

Note that sort criteria are applied on the server, that is, the locale of the server is used for sorting.

threshold - The maximum number of query result set tuples to be returned from the server to the client. If a threshold is not to be applied, null must be specified.
timeZone - The time zone of the timestamp constants in the whereClause. If a timezone is not specified, UTC is assumed.

Returns:
QueryResultSet - An object containing the query result. If qualifying tuples are not found, an empty query result set is returned. Refer to QueryResultSet for information on how to analyze the query result set.

Throws:
WorkItemManagerException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0

query

public 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)
                     throws WorkItemManagerException,
                            UnexpectedFailureException,
                            java.rmi.RemoteException,
                            javax.ejb.EJBException
Retrieves selected object properties persistently stored in the database.

You can specify a filter, a starting tuple, or a threshold to restrict the number of tuples returned. The tuples are sorted on the server according to the specified sort criteria.

Specify the parameters of the query, the select-, where-, and order-by-clause, using SQL based on the published process views. Execution of the query can thus be shifted to SQL and becomes portable and optimizable.

The domain of the query, that is, the SQL from-clause, is determined automatically. In principle, all properties of objects are selectable for which you own a work item, that is, which can be transitively reached via a user's work item. As a rule of thumb, all objects except process templates can be reached via work items.

The business process administrator has special rights and can access all objects, included process templates, that is, the business process administrator is the only user who can use properties of the PROCESS_TEMPLATE view only. All other users must specify a non process template property in the select- or where-clause.

Specified by:
query in interface BusinessFlowManagerService
Parameters:
selectClause - Describes the query result, that is, declares a list of names that identify the object properties (columns of the result) to be returned. Its syntax is an SQL select-clause. Aggregation functions like AVG(), SUM(), MIN(), and MAX() are, however, not supported. Each comma separated part of the select-clause must specify a property from the published process views - see the InfoCenter for details.

To select properties of name-value pairs like custom properties, add a one-digit suffix (0-9) to the view name. For example, "ACTIVITY_ATTRIBUTE1.VALUE, ACTIVITY_ATTRIBUTE2.VALUE".

To count the number of potentially qualifying tuples, use the COUNT keyword. For example, to count the number of activity instance IDs that satisfy the where-clause, specify a select-clause such as "COUNT(DISTINCT ACTIVITY.AIID)". If you use the more generic "COUNT(*)", then you must specify a where-clause so that the tuples to be counted can be determined. For example, to count all activities, specify a where-clause such as "ACTIVITY.AIID=ACTIVITY.AIID" that always evaluates to true.

The QueryResultSet contains columns in the same order as specified in the selectClause. If tuples are to be counted, an int value is returned (row 1, column 1).

whereClause - The search condition to be applied to the query domain. Its syntax is an SQL where-clause. The following rules apply:
  • Specify object ID constants as ID('string-rep-of-oid').
  • Specify timestamp constants as TS('yyyy-mm-ddThh:mm:ss') or as CURRENT_DATE for comparisons with the current date.
    The date and time parts of a TS definition are optional; either the date or the time must be specified. If no date part of a TS definition is specified, the current date is taken. Optional time values that are not specified are set to zero. The timestamp is 24 hours based. For example, TS('16:04') is the same as TS('2002-12-24T16:04:00') provided that the current date is December 24th, 2002.
    If a date part of a TS definition is specified, the year must consist of 4 letters; the month and day specifications are optional. Missing month and day specifications are set to 01. For example, specifying TS('2003') is the same as specifying TS('2003-01-01T00:00:00').
  • Specify binary constants as BIN('UTF-8 string').
  • Use constants instead of integer enumerations. For example, instead of specifying an activity state expression "ACTIVITY.STATE=2" , specify "ACTIVITY.STATE=ACTIVITY.STATE.STATE_READY".
  • Duplicate apostrophes (') in comparising values. For example, "ACTIVITY.NAME='d''automatisation'".
  • To specify a where clause that refers to properties of name-value pairs, like custom properties, add a one-digit suffix (0-9) to the view name.
    For example, to have only tuples returned where an activity custom property "prop1" has the value "v1" or where an activity custom property "prop2" has the value v2", the where clause can look like "ACTIVITY_ATTRIBUTE1.NAME='prop1' AND ACTIVITY_ATTRIBUTE1.VALUE='v1' OR ACTIVITY_ATTRIBUTE2.NAME='prop2' AND ACTIVITY_ATTRIBUTE2.VALUE = 'v2'". For performance reasons, you should not use more than one "OR" construct; use "IN" instead.
    For example, to retrieve the values of custom properties "prop1" and "prop2" of all activity instances, the select clause can look like "DISTINCT ACTIVITY.AIID, ACTIVITY_ATTRIBUTE1.VALUE, ACTIVITY_ATTRIBUTE2.VALUE" and the where-clause "ACTIVITY_ATTRIBUTE1.NAME = 'prop1' AND ACTIVITY_ATTRIBUTE2.NAME = 'prop2'".

If a filter is not to be applied, null must be specified.

orderByClause - Sorts the query result set by the values of the columns you identify. Its syntax is an SQL order-by-clause. Each comma separated part of the order-by-clause must specify a property from the published process views - see the InfoCenter for details.

If you identify more that one property, the query result set is ordered by the values of the first property you identify, then by the values of the second property, and so on.

If sort criteria are not to be applied, null must be specified.

Note that sort criteria are applied on the server, that is, the locale of the server is used for sorting.

skipTuples - The number of query result set tuples to be ignored and not to be returned to the caller. For example, a value of '5' means that the first 5 qualifying tuples are not returned. Use this parameter together with the threshold to implement paging in your client application.

If all qualifying tuples are to be returned, null or 0 must be specified.

threshold - The maximum number of query result set tuples to be returned from the server to the client. If a threshold is not to be applied, null must be specified.
timeZone - The time zone of the timestamp constants in the whereClause. If a timezone is not specified, UTC is assumed.

Returns:
QueryResultSet - An object containing the query result. If qualifying tuples are not found, an empty query result set is returned. Refer to QueryResultSet for information on how to analyze the query result set.

Throws:
WorkItemManagerException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

queryAll

public 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)
                        throws EngineNotAuthorizedException,
                               EngineParameterNullException,
                               WorkItemManagerException,
                               UnexpectedFailureException,
                               java.rmi.RemoteException,
                               javax.ejb.EJBException
Retrieves selected object properties of all objects persistently stored in the database and allows for retrieving a specified set of data only.

You can specify a filter, a starting tuple, or a threshold to restrict the number of tuples returned. The tuples are sorted on the server according to the specified sort criteria.

Specify the parameters of the query, the select-, where-, and order-by-clause, using SQL based on the published process views. Execution of the query can thus be shifted to SQL and becomes portable and optimizable.

The domain of the query, that is, the SQL from-clause, is determined automatically.

The caller must be a business process administrator or system monitor.

Specified by:
queryAll in interface BusinessFlowManagerService
Parameters:
selectClause - Describes the query result, that is, declares a list of names that identify the object properties (columns of the result) to be returned. Its syntax is an SQL select-clause. Aggregation functions like AVG(), SUM(), MIN(), and MAX() are, however, not supported. Each comma separated part of the select-clause must specify a property from the published process views - see the InfoCenter for details.

To select properties of name-value pairs like custom properties, add a one-digit suffix (0-9) to the view name. For example, "ACTIVITY_ATTRIBUTE1.VALUE, ACTIVITY_ATTRIBUTE2.VALUE".

To count the number of potentially qualifying tuples, use the COUNT keyword. For example, to count the number of activity instance IDs that satisfy the where-clause, specify a select-clause such as "COUNT(DISTINCT ACTIVITY.AIID)". If you use the more generic "COUNT(*)", then you must specify a where-clause so that the tuples to be counted can be determined. For example, to count all activities, specify a where-clause such as "ACTIVITY.AIID=ACTIVITY.AIID" that always evaluates to true.

The QueryResultSet contains columns in the same order as specified in the selectClause. If tuples are to be counted, an int value is returned (row 1, column 1).

whereClause - The search condition to be applied to the query domain. Its syntax is an SQL where-clause. The following rules apply:
  • Specify object ID constants as ID('string-rep-of-oid').
  • Specify timestamp constants as TS('yyyy-mm-ddThh:mm:ss') or as CURRENT_DATE for comparisons with the current date.
    The date and time parts of a TS definition are optional; either the date or the time must be specified. If no date part of a TS definition is specified, the current date is taken. Optional time values that are not specified are set to zero. The timestamp is 24 hours based. For example, TS('16:04') is the same as TS('2002-12-24T16:04:00') provided that the current date is December 24th, 2002.
    If a date part of a TS definition is specified, the year must consist of 4 letters; the month and day specifications are optional. Missing month and day specifications are set to 01. For example, specifying TS('2003') is the same as specifying TS('2003-01-01T00:00:00').
  • Specify binary constants as BIN('UTF-8 string').
  • Use constants instead of integer enumerations. For example, instead of specifying an activity state expression "ACTIVITY.STATE=2" , specify "ACTIVITY.STATE=ACTIVITY.STATE.STATE_READY".
  • Duplicate apostrophes (') in comparising values. For example, "ACTIVITY.NAME='d''automatisation'".
  • To specify a where clause that refers to properties of name-value pairs, like custom properties, add a one-digit suffix (0-9) to the view name.
    For example, to have only tuples returned where an activity custom property "prop1" has the value "v1" or where an activity custom property "prop2" has the value v2", the where clause can look like "ACTIVITY_ATTRIBUTE1.NAME='prop1' AND ACTIVITY_ATTRIBUTE1.VALUE='v1' OR ACTIVITY_ATTRIBUTE2.NAME='prop2' AND ACTIVITY_ATTRIBUTE2.VALUE = 'v2'". For performance reasons, you should not use more than one "OR" construct; use "IN" instead.
    For example, to retrieve the values of custom properties "prop1" and "prop2" of all activity instances, the select clause can look like "DISTINCT ACTIVITY.AIID, ACTIVITY_ATTRIBUTE1.VALUE, ACTIVITY_ATTRIBUTE2.VALUE" and the where-clause "ACTIVITY_ATTRIBUTE1.NAME = 'prop1' AND ACTIVITY_ATTRIBUTE2.NAME = 'prop2'".

If a filter is not to be applied, null must be specified.

orderByClause - Sorts the query result set by the values of the columns you identify. Its syntax is an SQL order-by-clause. Each comma separated part of the order-by-clause must specify a property from the published process views - see the InfoCenter for details.

If you identify more that one property, the query result set is ordered by the values of the first property you identify, then by the values of the second property, and so on.

If sort criteria are not to be applied, null must be specified.

Note that sort criteria are applied on the server, that is, the locale of the server is used for sorting.

skipTuples - The number of query result set tuples to be ignored and not to be returned to the caller. For example, a value of '5' means that the first 5 qualifying tuples are not returned. Use this parameter together with the threshold to implement paging in your client application.

If all qualifying tuples are to be returned, null or 0 must be specified.

threshold - The maximum number of query result set tuples to be returned from the server to the client. If a threshold is not to be applied, null must be specified.
timeZone - The time zone of the timestamp constants in the whereClause. If a timezone is not specified, UTC is assumed.

Returns:
QueryResultSet - An object containing the query result. If qualifying tuples are not found, an empty query result set is returned. Refer to QueryResultSet for information on how to analyze the query result set.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
WorkItemManagerException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

getActivityInstance

public ActivityInstanceData getActivityInstance(java.lang.String aiid)
                                         throws EngineNotAuthorizedException,
                                                EngineWrongKindException,
                                                EngineWrongStateException,
                                                IdWrongFormatException,
                                                IdWrongTypeException,
                                                InvalidLengthException,
                                                ObjectDoesNotExistException,
                                                UnexpectedFailureException,
                                                java.rmi.RemoteException,
                                                javax.ejb.EJBException
Retrieves the specified activity instance using a string representation of the activity instance ID.

The activity instance and the associated process instance can be in any execution state. The caller must have at least reader authority for the activity instance or for the associated process instance.

Specified by:
getActivityInstance in interface BusinessFlowManagerService
Parameters:
aiid - A string representation of the activity instance object ID. This is used to identify the activity instance to be retrieved.

Returns:
ActivityInstanceData - The activity instance. Refer to ActivityInstanceData to view the activity instance properties.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getActivityInstance

public ActivityInstanceData getActivityInstance(AIID aiid)
                                         throws EngineNotAuthorizedException,
                                                IdWrongFormatException,
                                                InvalidLengthException,
                                                ObjectDoesNotExistException,
                                                UnexpectedFailureException,
                                                java.rmi.RemoteException,
                                                javax.ejb.EJBException
Retrieves the specified activity instance using the activity instance ID.

The activity instance and the associated process instance can be in any execution state. The caller must have at least reader authority for the activity instance or for the associated process instance.

Specified by:
getActivityInstance in interface BusinessFlowManagerService
Parameters:
aiid - The object ID of the activity instance to be retrieved.

Returns:
ActivityInstanceData - The activity instance. Refer to ActivityInstanceData to view the activity instance properties.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getActivityInstance

public ActivityInstanceData getActivityInstance(java.lang.String piid,
                                                java.lang.String activityTemplateName)
                                         throws ActivityNameNotUniqueException,
                                                EngineNotAuthorizedException,
                                                EngineParameterNullException,
                                                EngineWrongKindException,
                                                EngineWrongStateException,
                                                IdWrongFormatException,
                                                IdWrongTypeException,
                                                InvalidLengthException,
                                                ObjectDoesNotExistException,
                                                UnexpectedFailureException,
                                                java.rmi.RemoteException,
                                                javax.ejb.EJBException
Retrieves the specified activity instance using a string representation of the process instance ID and the activity template name.

The activity instance and the associated process instance can be in any execution state. The caller must have at least reader authority for the activity instance or for the associated process instance.

Specified by:
getActivityInstance in interface BusinessFlowManagerService
Parameters:
piid - The String representation of the object ID of the containing process instance.
activityTemplateName - The name of the activity template that describes the activity instance to be retrieved.

Returns:
ActivityInstanceData - The activity instance retrieved. Refer to ActivityInstanceData to view the activity instance properties.

Throws:
ActivityNameNotUniqueException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getActivityInstance

public ActivityInstanceData getActivityInstance(PIID piid,
                                                java.lang.String activityTemplateName)
                                         throws ActivityNameNotUniqueException,
                                                EngineNotAuthorizedException,
                                                EngineParameterNullException,
                                                EngineWrongKindException,
                                                EngineWrongStateException,
                                                IdWrongFormatException,
                                                IdWrongTypeException,
                                                InvalidLengthException,
                                                ObjectDoesNotExistException,
                                                UnexpectedFailureException,
                                                java.rmi.RemoteException,
                                                javax.ejb.EJBException
Retrieves the specified activity instance using the process instance ID and the activity template name.

The activity instance and the associated process instance can be in any execution state. The caller must have at least reader authority for the activity instance or for the associated process instance.

Specified by:
getActivityInstance in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance.
activityTemplateName - The name of the activity template that describes the activity instance to be retrieved.

Returns:
ActivityInstanceData - The activity instance retrieved. Refer to ActivityInstanceData to view the activity instance properties.

Throws:
ActivityNameNotUniqueException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getAvailableActionFlags

public boolean[][] getAvailableActionFlags(java.lang.String[] identifiers)
                                    throws IdWrongFormatException,
                                           IdWrongTypeException,
                                           EngineNotAuthorizedException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException,
                                           java.rmi.RemoteException,
                                           javax.ejb.EJBException
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. Refer to ProcessInstanceActions or to ActivityInstanceActions for the set of possible actions.

Specified by:
getAvailableActionFlags in interface BusinessFlowManagerService
Parameters:
identifiers - An array of String representation of object IDs. These objects IDs must all represent either process instance IDs or activity instance IDs.

Returns:
boolean[][] - An array of actions that can be called for each specified process instance. The array returns a row per process instance. The columns indicate whether a possible action can be called for the process instance. True states that the action can be called. False states that the action cannot be called by the logged-on user in the current process instance state. Refer to ProcessInstanceActionIndex for index constants that can be used to access the columns of the two-dimensional array.

Throws:
IdWrongFormatException
IdWrongTypeException
EngineNotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

getAvailableActionFlags

public boolean[][] getAvailableActionFlags(PIID[] piids)
                                    throws IdWrongFormatException,
                                           EngineNotAuthorizedException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException,
                                           java.rmi.RemoteException,
                                           javax.ejb.EJBException
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. Refer to ProcessInstanceActions for the set of possible actions.

Specified by:
getAvailableActionFlags in interface BusinessFlowManagerService
Parameters:
piids - An array of process instance IDs.

Returns:
boolean[][] - An array of actions that can be called for each specified process instance. The array returns a row per process instance. The columns indicate whether a possible action can be called for the process instance. True states that the action can be called. False states that the action cannot be called by the logged-on user in the current process instance state. Refer to ProcessInstanceActionIndex for index constants that can be used to access the columns of the two-dimensional array.

Throws:
IdWrongFormatException
EngineNotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

getAvailableActionFlags

public boolean[][] getAvailableActionFlags(AIID[] aiids)
                                    throws IdWrongFormatException,
                                           EngineNotAuthorizedException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException,
                                           java.rmi.RemoteException,
                                           javax.ejb.EJBException
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. Refer to ActivityInstanceActions for the set of possible actions.

Specified by:
getAvailableActionFlags in interface BusinessFlowManagerService
Parameters:
aiids - An array of activity instance IDs.

Returns:
boolean[][] - An array of actions that can be called for each specified activity instance. The array returns a row per activity instance. The columns indicate whether a possible action can be called for the activity instance. True states that the action can be called. False states that the action cannot be called by the logged-on user in the current activity instance state. Refer to ActivityInstanceActionIndex for index constants that can be used to access the columns of the two-dimensional array.

Throws:
IdWrongFormatException
EngineNotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

getProcessTemplate

public ProcessTemplateData getProcessTemplate(PTID ptid)
                                       throws EngineNotAuthorizedException,
                                              IdWrongFormatException,
                                              InvalidLengthException,
                                              ObjectDoesNotExistException,
                                              UnexpectedFailureException,
                                              java.rmi.RemoteException,
                                              javax.ejb.EJBException
Retrieves the specified process template using the process template ID.

The caller must be authorized for the process template.

Specified by:
getProcessTemplate in interface BusinessFlowManagerService
Parameters:
ptid - The object ID of the process template to be retrieved.

Returns:
ProcessTemplateData - The process template. Refer to ProcessTemplateData to view the process template properties.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getProcessTemplate

public ProcessTemplateData getProcessTemplate(java.lang.String identifier)
                                       throws EngineNotAuthorizedException,
                                              EngineParameterNullException,
                                              IdWrongTypeException,
                                              InvalidLengthException,
                                              ObjectDoesNotExistException,
                                              UnexpectedFailureException,
                                              java.rmi.RemoteException,
                                              javax.ejb.EJBException
Retrieves the specified process template using a string representation of the process template ID or the process template name. When a process template name is provided and there exists more than one template with this name, then the currently valid template is returned.

The caller must be authorized for the process template.

Specified by:
getProcessTemplate in interface BusinessFlowManagerService
Parameters:
identifier - The string representation of the process template object ID or the process template name. This is used to identify the process template to be retrieved.

Returns:
ProcessTemplateData - The process template. Refer to ProcessTemplateData to view the process template properties.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getProcessInstance

public ProcessInstanceData getProcessInstance(java.lang.String identifier)
                                       throws EngineNotAuthorizedException,
                                              EngineParameterNullException,
                                              IdWrongTypeException,
                                              InvalidLengthException,
                                              ObjectDoesNotExistException,
                                              UnexpectedFailureException,
                                              java.rmi.RemoteException,
                                              javax.ejb.EJBException
Retrieves the specified process instance using a string representation of the process instance ID or the process instance name.

The process instance can be in any execution state. The caller must have at least reader authority for the process instance.

Specified by:
getProcessInstance in interface BusinessFlowManagerService
Parameters:
identifier - The string representation of the process instance object ID or the process instance name. This is used to identify the process instance to be retrieved.

Returns:
ProcessInstanceData - The process instance. Refer to ProcessInstanceData to view the process instance properties.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getProcessInstance

public ProcessInstanceData getProcessInstance(PIID piid)
                                       throws EngineNotAuthorizedException,
                                              IdWrongFormatException,
                                              InvalidLengthException,
                                              ObjectDoesNotExistException,
                                              UnexpectedFailureException,
                                              java.rmi.RemoteException,
                                              javax.ejb.EJBException
Retrieves the specified process instance using the process instance ID.

The process instance can be in any execution state. The caller must have at least reader authority for the process instance.

Specified by:
getProcessInstance in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance to be retrieved.

Returns:
ProcessInstanceData - The process instance. Refer to ProcessInstanceData to view the process instance properties.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getInputMessage

public ClientObjectWrapper getInputMessage(java.lang.String identifier)
                                    throws DataHandlingException,
                                           EngineNotAuthorizedException,
                                           EngineWrongKindException,
                                           EngineWrongStateException,
                                           IdWrongFormatException,
                                           IdWrongTypeException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException,
                                           java.rmi.RemoteException,
                                           javax.ejb.EJBException
Retrieves the input message of the specified process or activity instance using a string representation of the ID.

The input message can be retrieved in any execution state of the process instance. The input message can be retrieved in the claimed, expired, failed, finished, terminated, ready, or stopped execution state of the activity instance. The activity can be an invoke or staff activity.

The caller must have at least reader authority for the process or activity instance.

Specified by:
getInputMessage in interface BusinessFlowManagerService
Parameters:
identifier - A string representation of the process or activity instance object ID. The string is used to identify the process instance or activity instance for which the input message is to be retrieved.

Returns:
ClientObjectWrapper - The input message.

Throws:
DataHandlingException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getInputMessage

public ClientObjectWrapper getInputMessage(PIID piid)
                                    throws EngineNotAuthorizedException,
                                           EngineWrongKindException,
                                           EngineWrongStateException,
                                           IdWrongFormatException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException,
                                           java.rmi.RemoteException,
                                           javax.ejb.EJBException
Retrieves the input message of the specified process instance using the process instance ID.

The input message can be retrieved in any execution state of the process instance. The caller must have at least reader authority for the process instance.

Specified by:
getInputMessage in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance whose input message is to be retrieved.

Returns:
ClientObjectWrapper - The input message.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getInputMessage

public ClientObjectWrapper getInputMessage(AIID aiid)
                                    throws DataHandlingException,
                                           EngineNotAuthorizedException,
                                           EngineWrongKindException,
                                           EngineWrongStateException,
                                           IdWrongFormatException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException,
                                           java.rmi.RemoteException,
                                           javax.ejb.EJBException
Retrieves the input message of the specified activity instance using the activity instance ID.

The input message can be retrieved in any execution state of the associated process instance. The input message can be retrieved in the claimed, expired, failed, finished, terminated, ready, or stopped execution state of the activity instance. The activity can be an invoke or staff activity.

The caller must have at least reader authority for the activity instance or for the associated process instance.

Specified by:
getInputMessage in interface BusinessFlowManagerService
Parameters:
aiid - The object ID of the activity instance whose input message is to be retrieved.

Returns:
ClientObjectWrapper - The input message.

Throws:
DataHandlingException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getOutputMessage

public ClientObjectWrapper getOutputMessage(java.lang.String identifier)
                                     throws DataHandlingException,
                                            EngineNotAuthorizedException,
                                            EngineWrongKindException,
                                            EngineWrongStateException,
                                            IdWrongFormatException,
                                            IdWrongTypeException,
                                            ObjectDoesNotExistException,
                                            UnexpectedFailureException,
                                            java.rmi.RemoteException,
                                            javax.ejb.EJBException
Retrieves the output message of the specified process or activity instance using a string representation of the ID.

An output message can be retrieved in any execution state of the process instance. The output message can be retrieved in the claimed, expired, failed, finished, terminated, ready, or stopped execution state of the activity instance. The activity can be a request-response invoke or a staff activity. Note that that any saved output message of an expired (non-completed) staff activity has been deleted.

The caller must have at least reader authority for the process or activity instance.

Specified by:
getOutputMessage in interface BusinessFlowManagerService
Parameters:
identifier - A string representation of the process or activity instance object ID that is used to identify the process instance or activity instance for which the output message is to be retrieved.

Returns:
ClientObjectWrapper - The output message. If the output message has not yet been created, a empty client object wrapper is returned.

Throws:
DataHandlingException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getOutputMessage

public ClientObjectWrapper getOutputMessage(PIID piid)
                                     throws EngineNotAuthorizedException,
                                            EngineWrongKindException,
                                            EngineWrongStateException,
                                            IdWrongFormatException,
                                            ObjectDoesNotExistException,
                                            UnexpectedFailureException,
                                            java.rmi.RemoteException,
                                            javax.ejb.EJBException
Retrieves the output message of the specified process instance using the process instance ID.

The output message can be retrieved in any execution state of the process instance. The caller must have at least reader authority for the process instance.

Specified by:
getOutputMessage in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance whose output message is to be retrieved.

Returns:
ClientObjectWrapper - The output message. If an output message has not yet been created, an empty client object wrapper is returned.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getOutputMessage

public ClientObjectWrapper getOutputMessage(AIID aiid)
                                     throws DataHandlingException,
                                            EngineNotAuthorizedException,
                                            EngineWrongKindException,
                                            EngineWrongStateException,
                                            IdWrongFormatException,
                                            ObjectDoesNotExistException,
                                            UnexpectedFailureException,
                                            java.rmi.RemoteException,
                                            javax.ejb.EJBException
Retrieves the output message of the specified activity instance using the activity instance ID.

An output message can be retrieved in any execution state of the associated process instance. The output message can be retrieved in the claimed, expired, failed, finished, terminated, ready, or stopped execution state of the activity instance. The activity can be a request-response invoke or a staff activity. Note that that any saved output message of an expired (non-completed) staff activity has been deleted.

The caller must have at least reader authority for the activity instance or for the associated process instance.

Specified by:
getOutputMessage in interface BusinessFlowManagerService
Parameters:
aiid - The object ID of the activity instance whose output message is to be retrieved.

Returns:
ClientObjectWrapper - The output message. If the output message has not yet been created, an empty client object wrapper is returned.

Throws:
DataHandlingException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

setOutputMessage

public void setOutputMessage(java.lang.String aiid,
                             ClientObjectWrapper outputMessage)
                      throws EngineNotAuthorizedException,
                             EngineParameterNullException,
                             EngineWrongKindException,
                             EngineWrongMessageTypeException,
                             EngineWrongStateException,
                             IdWrongFormatException,
                             IdWrongTypeException,
                             ObjectDoesNotExistException,
                             UnexpectedFailureException,
                             java.rmi.RemoteException,
                             javax.ejb.EJBException
Stores the output message of the specified activity instance into the database using a string representation of the activity instance ID. The output message is saved only, that is, navigation does not continue. Refer to complete or to forceComplete for information on how to complete an activity instance.

Any previously stored output or fault message is deleted.

The activity instance must be in the claimed or stopped execution state and the associated process instance must be in the running, failing, or terminating execution state. The caller must have editor authority for the activity instance, be the owner of the activity instance, or be the administrator of the associated process instance.

The activity must be a staff activity. To repair variables used by a stopped invoke or script activity, refer to setVariable.

Specified by:
setOutputMessage in interface BusinessFlowManagerService
Parameters:
aiid - A string representation of the activity instance object ID. This is used to identify the activity instance whose output message is to be set.

outputMessage - The output message. The object wrapped by the ClientObjectWrapper must be serializable.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

setOutputMessage

public void setOutputMessage(AIID aiid,
                             ClientObjectWrapper outputMessage)
                      throws EngineNotAuthorizedException,
                             EngineParameterNullException,
                             EngineWrongKindException,
                             EngineWrongMessageTypeException,
                             EngineWrongStateException,
                             IdWrongFormatException,
                             ObjectDoesNotExistException,
                             UnexpectedFailureException,
                             java.rmi.RemoteException,
                             javax.ejb.EJBException
Stores the output message of the specified activity instance into the database using the activity instance ID. The output message is saved only, that is, navigation does not continue. Refer to complete or to forceComplete for information on how to complete an instance.

Any previously stored output or fault message is deleted.

The activity instance must be in the claimed or stopped execution state and the associated process instance must be in the running, failing, or terminating execution state. The caller must have editor authority for the activity instance, be the owner of the activity instance, or be the administrator of the associated process instance.

The activity must be a staff activity. To repair variables used by a stopped invoke or script activity, refer to setVariable.

Specified by:
setOutputMessage in interface BusinessFlowManagerService
Parameters:
aiid - The object ID of the activity instance whose output message is to be set.

outputMessage - The output message. The object wrapped by the ClientObjectWrapper must be serializable.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getFaultNames

public java.util.List getFaultNames(java.lang.String aiid)
                             throws EngineNotAuthorizedException,
                                    EngineWrongKindException,
                                    EngineWrongStateException,
                                    IdWrongFormatException,
                                    IdWrongTypeException,
                                    ObjectDoesNotExistException,
                                    UnexpectedFailureException,
                                    java.rmi.RemoteException,
                                    javax.ejb.EJBException
Retrieves the fault names defined for the specified activity instance using a string representation of the activity instance ID.

Fault names can be retrieved in any execution state of the associated process instance. The activity instance must be in the claimed, expired, failed, finished, terminated, ready, or stopped execution state. The activity can be a staff or invoke activity.

The caller must have at least reader authority for the activity instance or the associated process instance.

Specified by:
getFaultNames in interface BusinessFlowManagerService
Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance for which fault names are to be retrieved.

Returns:
List - A list of fault names. If there are no faults, an empty list is returned. Fault names are to be specified when a fault message is set - refer to complete, forceComplete setFaultMessage, or to createMessage.

Note that, although strings are returned, the structure of a fault name is a QName.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getFaultNames

public java.util.List getFaultNames(AIID aiid)
                             throws EngineNotAuthorizedException,
                                    EngineWrongKindException,
                                    EngineWrongStateException,
                                    IdWrongFormatException,
                                    ObjectDoesNotExistException,
                                    UnexpectedFailureException,
                                    java.rmi.RemoteException,
                                    javax.ejb.EJBException
Retrieves the fault names defined for the specified activity instance using the activity instance ID.

Fault names can be retrieved in any execution state of the associated process instance. The activity instance must be in the claimed, expired, failed, finished, terminated, ready, or stopped execution state. The activity can be a staff or invoke activity.

The caller must have at least reader authority for the activity or associated process instance.

Specified by:
getFaultNames in interface BusinessFlowManagerService
Parameters:
aiid - The object ID of the activity instance for which the fault names are to be retrieved.

Returns:
List - A list of fault names. If there are no faults, an empty list is returned. Fault names are to be specified when a fault message is set. Refer to complete, forceComplete setFaultMessage, or to createMessage.

Note that, although strings are returned, the structure of a fault name is a QName.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getFaultMessage

public ClientObjectWrapper getFaultMessage(java.lang.String identifier)
                                    throws DataHandlingException,
                                           EngineNotAuthorizedException,
                                           EngineWrongKindException,
                                           EngineWrongStateException,
                                           IdWrongFormatException,
                                           IdWrongTypeException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException,
                                           java.rmi.RemoteException,
                                           javax.ejb.EJBException
Retrieves the fault message of the specified process or activity instance using a string representation of the process or activity instance ID.

The fault message can be retrieved in any execution state of the process instance. The activity instance must be in the claimed, expired, failed, finished, terminated, ready, or stopped execution state. The activity can be an invoke, script, or staff activity. Note that that any saved fault message of an expired (non-completed) staff activity has been deleted.

The caller must have at least reader authority for the process or activity instance.

Specified by:
getFaultMessage in interface BusinessFlowManagerService
Parameters:
identifier - A string representation of the process or activity instance object ID. This string is used to identify the process instance or activity instance for which the fault message is to be retrieved.

Returns:
ClientObjectWrapper - The fault message. If there is no fault message, an empty client object wrapper is returned.

Throws:
DataHandlingException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getFaultMessage

public ClientObjectWrapper getFaultMessage(PIID piid)
                                    throws EngineNotAuthorizedException,
                                           EngineWrongKindException,
                                           EngineWrongStateException,
                                           IdWrongFormatException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException,
                                           java.rmi.RemoteException,
                                           javax.ejb.EJBException
Retrieves the fault message of the specified process instance using the process instance ID.

The fault message can be retrieved in any execution state of the process instance. The caller must have at least reader authority for the process instance.

Specified by:
getFaultMessage in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance for which the fault message is to be retrieved.

Returns:
ClientObjectWrapper - The fault message. If there is no fault message, an empty client object wrapper is returned.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getFaultMessage

public ClientObjectWrapper getFaultMessage(AIID aiid)
                                    throws DataHandlingException,
                                           EngineNotAuthorizedException,
                                           EngineWrongKindException,
                                           EngineWrongStateException,
                                           IdWrongFormatException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException,
                                           java.rmi.RemoteException,
                                           javax.ejb.EJBException
Retrieves the fault message of the specified activity instance using the activity instance ID.

The fault message can be retrieved in any execution state of the associated process instance. The activity instance must be in the claimed, expired, failed, finished, terminated, ready, or stopped execution state. The activity can be an invoke, script, or staff activity. Note that that any saved fault message of an expired (non-completed) staff activity has been deleted.

The caller must have at least reader authority for the activity instance or for the associated process instance.

Specified by:
getFaultMessage in interface BusinessFlowManagerService
Parameters:
aiid - The object ID of the activity instance for which the fault message is to be retrieved.

Returns:
ClientObjectWrapper - The fault message. If there is no fault message, an empty client object wrapper is returned.

Throws:
DataHandlingException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

setFaultMessage

public void setFaultMessage(java.lang.String aiid,
                            java.lang.String faultName,
                            ClientObjectWrapper faultMessage)
                     throws EngineNotAuthorizedException,
                            EngineParameterNullException,
                            EngineWrongKindException,
                            EngineWrongMessageTypeException,
                            EngineWrongStateException,
                            IdWrongFormatException,
                            IdWrongTypeException,
                            ObjectDoesNotExistException,
                            UnexpectedFailureException,
                            java.rmi.RemoteException,
                            javax.ejb.EJBException
Stores the specified fault message for the specified activity instance into the database using a string representation of the activity instance ID. The fault message is saved only, that is, navigation does not continue. Refer to complete or forceComplete for information on how to complete an activity instance.

Any previously stored fault or output message is deleted.

The activity instance must be in the claimed or stopped execution state and the associated process instance must be in the running, failing, or terminating execution state. The caller must have editor authority for the activity instance, be the owner of the activity instance, or be the administrator of the associated process instance.

The activity must be a staff activity. To repair variables used by a stopped invoke or script activity, refer to setVariable.

Specified by:
setFaultMessage in interface BusinessFlowManagerService
Parameters:
aiid - A string representation of the activity instance object ID. This string is used to identify the activity instance whose fault message is to be set.
faultName - The name of the fault message to be set. Must be a fault defined for the activity. Refer to getFaultNames. Note that the structure of a BPEL fault name is a QName.
faultMessage - The fault message. The object wrapped by the ClientObjectWrapper must be serializable.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

setFaultMessage

public void setFaultMessage(AIID aiid,
                            java.lang.String faultName,
                            ClientObjectWrapper faultMessage)
                     throws EngineNotAuthorizedException,
                            EngineParameterNullException,
                            EngineWrongKindException,
                            EngineWrongMessageTypeException,
                            EngineWrongStateException,
                            IdWrongFormatException,
                            ObjectDoesNotExistException,
                            UnexpectedFailureException,
                            java.rmi.RemoteException,
                            javax.ejb.EJBException
Stores the specified fault message for the specified activity instance into the database using the activity instance ID. The fault message is saved only, that is, navigation does not continue. Refer to complete or forceComplete for information on how to complete an activity instance.

Any previously stored fault or output message is deleted.

The activity instance must be in the claimed or stopped execution state and the associated process instance must be in the running, failing, or terminating execution state. The caller must have editor authority for the activity instance, be the owner of the activity instance, or be the administrator of the associated process instance.

The activity must be a staff activity. To repair variables used by a stopped invoke or script activity, refer to setVariable.

Specified by:
setFaultMessage in interface BusinessFlowManagerService
Parameters:
aiid - The activity instance object ID that is used to identify the activity instance whose fault message is to be set.
faultName - The name of the fault message to be set. Must be a fault defined for the activity. Refer to getFaultNames. Note that the structure of a BPEL fault name is a QName.
faultMessage - The fault message. The object wrapped by the ClientObjectWrapper must be serializable.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getVariable

public ClientObjectWrapper getVariable(java.lang.String identifier,
                                       java.lang.String variableName)
                                throws EngineNotAuthorizedException,
                                       EngineParameterNullException,
                                       EngineVariableDoesNotExistException,
                                       EngineWrongKindException,
                                       EngineWrongStateException,
                                       IdWrongFormatException,
                                       IdWrongTypeException,
                                       ObjectDoesNotExistException,
                                       UnexpectedFailureException,
                                       java.rmi.RemoteException,
                                       javax.ejb.EJBException
Retrieves the specified variable of the specified process instance or the specified variable visible in the scope of the specified activity instance using a string representation of the process or activity instance ID.

Variables allow to store business data for the process, across activity invocations. They can be retrieved in any execution state of the process instance. The caller must have at least reader authority for the process instance or activity instance .

Specified by:
getVariable in interface BusinessFlowManagerService
Parameters:
identifier - A string representation of the process instance object ID or activity instance object ID. This string is used to identify the process instance resp. activity instance for which the specified variable is to be retrieved.

variableName - The name of the variable to be retrieved.

Returns:
ClientObjectWrapper - The variable. If the specified variable is not found, an empty client object wrapper is returned.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineVariableDoesNotExistException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getVariable

public ClientObjectWrapper getVariable(PIID piid,
                                       java.lang.String variableName)
                                throws EngineNotAuthorizedException,
                                       EngineParameterNullException,
                                       EngineVariableDoesNotExistException,
                                       IdWrongFormatException,
                                       ObjectDoesNotExistException,
                                       UnexpectedFailureException,
                                       java.rmi.RemoteException,
                                       javax.ejb.EJBException
Retrieves the specified variable of the specified process instance using the process instance ID.

Variables allow to store business data for the process, across activity invocations. They can be retrieved in any execution state of the process instance. The caller must have at least reader authority for the process instance.

Specified by:
getVariable in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance for which the specified variable is to be retrieved.
variableName - The name of the variable to be retrieved.

Returns:
ClientObjectWrapper - The variable. If the specified variable is not found, an empty client object wrapper is returned.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineVariableDoesNotExistException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getVariable

public ClientObjectWrapper getVariable(AIID aiid,
                                       java.lang.String variableName)
                                throws EngineNotAuthorizedException,
                                       EngineParameterNullException,
                                       EngineVariableDoesNotExistException,
                                       EngineWrongKindException,
                                       EngineWrongStateException,
                                       IdWrongFormatException,
                                       ObjectDoesNotExistException,
                                       UnexpectedFailureException,
                                       java.rmi.RemoteException,
                                       javax.ejb.EJBException
Retrieves the specified variable of the scope visible in the specified activity instance using the activity instance ID.

Variables allow to store business data for the process instance, across activity invocations or for the activity. The caller must have at least reader authority for the activity instance.

Specified by:
getVariable in interface BusinessFlowManagerService
Parameters:
aiid - The object ID of the activity instance for which the specified variable is to be retrieved.
variableName - The name of the variable to be retrieved.

Returns:
ClientObjectWrapper - The variable. If the specified variable is not found, an empty client object wrapper is returned.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineVariableDoesNotExistException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

setVariable

public void setVariable(java.lang.String identifier,
                        java.lang.String variableName,
                        ClientObjectWrapper message)
                 throws EngineNotAuthorizedException,
                        EngineParameterNullException,
                        EngineVariableDoesNotExistException,
                        EngineWrongKindException,
                        EngineWrongMessageTypeException,
                        EngineWrongStateException,
                        IdWrongFormatException,
                        IdWrongTypeException,
                        ObjectDoesNotExistException,
                        UnexpectedFailureException,
                        java.rmi.RemoteException,
                        javax.ejb.EJBException
Sets the specified variable using the variable name and a string representation of the associated process or activity instance ID.

Variables allow to store business data for the process, across activity invocations or for the activity. This function supports process repair scenarios.

If the indentifier is the representation of a process instance object ID, the process instance must be in the running, failing, or terminating execution state. If the indentifier is the representation of a activity instance object ID, the activity instance must be in the compensating, running, or failing execution state. The caller must be an administrator of the process instance.

Specified by:
setVariable in interface BusinessFlowManagerService
Parameters:
identifier - A string representation of the process or activity instance object ID. This string is used to identify the process instance or the activity instance for which the specified variable is to be set.
variableName - The name of the variable to be set.
message - The message. The object wrapped by the ClientObjectWrapper must be serializable.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineVariableDoesNotExistException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

setVariable

public void setVariable(PIID piid,
                        java.lang.String variableName,
                        ClientObjectWrapper message)
                 throws EngineNotAuthorizedException,
                        EngineParameterNullException,
                        EngineVariableDoesNotExistException,
                        EngineWrongKindException,
                        EngineWrongMessageTypeException,
                        EngineWrongStateException,
                        IdWrongFormatException,
                        ObjectDoesNotExistException,
                        UnexpectedFailureException,
                        java.rmi.RemoteException,
                        javax.ejb.EJBException
Sets the specified variable using the variable name and the associated process instance ID.

Variables allow to store business data for the process, across activity invocations. This function supports process repair scenarios.

The process instance must be in the running, failing, or terminating execution state. The caller must be an administrator of the process instance.

Specified by:
setVariable in interface BusinessFlowManagerService
Parameters:
piid - The process instance object ID. The ID is used to identify the process instance for which the specified variable is to be set.
variableName - The name of the variable to be set.
message - The message. The object wrapped by the ClientObjectWrapper must be serializable.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineVariableDoesNotExistException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

setVariable

public void setVariable(AIID aiid,
                        java.lang.String variableName,
                        ClientObjectWrapper message)
                 throws EngineNotAuthorizedException,
                        EngineParameterNullException,
                        EngineVariableDoesNotExistException,
                        EngineWrongKindException,
                        EngineWrongMessageTypeException,
                        EngineWrongStateException,
                        IdWrongFormatException,
                        ObjectDoesNotExistException,
                        UnexpectedFailureException,
                        java.rmi.RemoteException,
                        javax.ejb.EJBException
Sets the specified variable in the scope visible for this activity using the variable name and the associated activity instance ID.

The activity instance must be in the compensating, running, or failing execution state. The caller must be an administrator of the process instance.

Specified by:
setVariable in interface BusinessFlowManagerService
Parameters:
aiid - The activity instance object ID. The ID is used to identify the activity instance for which the specified variable is to be set.
variableName - The name of the variable to be set.
message - The message. The object wrapped by the ClientObjectWrapper must be serializable.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineVariableDoesNotExistException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

createMessage

public ClientObjectWrapper createMessage(java.lang.String identifier,
                                         java.lang.String messageTypeName)
                                  throws EngineNotAuthorizedException,
                                         EngineWrongKindException,
                                         IdWrongFormatException,
                                         IdWrongTypeException,
                                         ObjectDoesNotExistException,
                                         UnexpectedFailureException,
                                         java.rmi.RemoteException,
                                         javax.ejb.EJBException
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. For example, creates a message that can be used when instantiating a process instance.

The caller must be authorized for the process template or must have at least reader authority for the process or activity instance.

Specified by:
createMessage in interface BusinessFlowManagerService
Parameters:
identifier - String representation of the object ID that is used to identify the process template, process instance, event handler template, or activity instance for which a message is to be created.
messageTypeName - The name of the message type for which a message is to be created. Refer to ProcessTemplateData.getInputMessageTypeName(), ProcessInstanceData.getInputMessageTypeName(), ActivityInstanceData.getInputMessageTypeName(), ActivityInstanceData.getOutputMessageTypeName(), getFaultNames, or to EventHandlerTemplateData.getInputMessageTypeName().

Returns:
ClientObjectWrapper - The message created. An empty client object wrapper is returned, when the specified message type cannot be found.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

createMessage

public ClientObjectWrapper createMessage(PTID ptid,
                                         java.lang.String messageTypeName)
                                  throws EngineNotAuthorizedException,
                                         IdWrongFormatException,
                                         ObjectDoesNotExistException,
                                         UnexpectedFailureException,
                                         java.rmi.RemoteException,
                                         javax.ejb.EJBException
Creates a message defined by the specified process template using the process template ID. For example, creates an input message that can be used when an instance is created from the specified process template.

The caller must be authorized for the process template.

Specified by:
createMessage in interface BusinessFlowManagerService
Parameters:
ptid - The object ID of the process template for which a message is to be created.
messageTypeName - The name of the message type for which a message is to be created. Refer to ProcessTemplateData.getInputMessageTypeName().

Returns:
ClientObjectWrapper - The message created. An empty client object wrapper is returned, when the specified message type cannot be found.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

createMessage

public ClientObjectWrapper createMessage(PIID piid,
                                         java.lang.String messageTypeName)
                                  throws EngineNotAuthorizedException,
                                         IdWrongFormatException,
                                         ObjectDoesNotExistException,
                                         UnexpectedFailureException,
                                         java.rmi.RemoteException,
                                         javax.ejb.EJBException
Creates a message defined by the specified process instance using the process instance ID. For example, creates a message that can be sent to the specified process instance.

The caller must have at least reader authority for the process instance.

Specified by:
createMessage in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance for which a message is to be created.
messageTypeName - The name of the message type for which a message is to be created. Refer to ProcessInstanceData.getInputMessageTypeName().

Returns:
ClientObjectWrapper - The message created. An empty client object wrapper is returned, when the specified message type cannot be found.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

createMessage

public ClientObjectWrapper createMessage(AIID aiid,
                                         java.lang.String messageTypeName)
                                  throws EngineNotAuthorizedException,
                                         EngineWrongKindException,
                                         IdWrongFormatException,
                                         ObjectDoesNotExistException,
                                         UnexpectedFailureException,
                                         java.rmi.RemoteException,
                                         javax.ejb.EJBException
Creates a message defined by the specified activity instance using the activity instance ID. For example, creates a message that can be used to complete a staff activity.

The caller must have at least reader authority for the activity instance or for the associated process instance.

Specified by:
createMessage in interface BusinessFlowManagerService
Parameters:
aiid - The object ID of the activity instance for which a message is to be created.
messageTypeName - The name of the message type for which a message is to be created. Refer to ActivityInstanceData.getInputMessageTypeName() or to ActivityInstanceData.getOutputMessageTypeName().

Returns:
ClientObjectWrapper - The message created. An empty client object wrapper is returned, when the specified message type cannot be found for the activity.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

createMessage

public ClientObjectWrapper createMessage(EHTID ehtid,
                                         java.lang.String messageTypeName)
                                  throws EngineNotAuthorizedException,
                                         IdWrongFormatException,
                                         ObjectDoesNotExistException,
                                         UnexpectedFailureException,
                                         java.rmi.RemoteException,
                                         javax.ejb.EJBException
Creates a message defined by the specified event handler template using the event handler template ID. For example, creates a message that can be sent to a waiting event.

The caller must be authorized for the event handler template.

Specified by:
createMessage in interface BusinessFlowManagerService
Parameters:
ehtid - The object ID of the event handler template for which a message is to be created.
messageTypeName - The name of the message type for which a message is to be created. Refer to EvetnHandlerTemplateData.getInputMessageTypeName().

Returns:
ClientObjectWrapper - The message created. An empty client object wrapper is returned, when the specified message type cannot be found.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

createMessage

public ClientObjectWrapper createMessage(java.lang.String vtid,
                                         java.lang.String atid,
                                         java.lang.String messageTypeName)
                                  throws EngineNotAuthorizedException,
                                         IdWrongFormatException,
                                         IdWrongTypeException,
                                         ObjectDoesNotExistException,
                                         UnexpectedFailureException,
                                         java.rmi.RemoteException,
                                         javax.ejb.EJBException
Creates a message defined by the specified activity service using string representations of object IDs. For example, creates a message that can be used when calling a service.

The caller must have at least reader authority for the associated process template.

Specified by:
createMessage in interface BusinessFlowManagerService
Parameters:
vtid - A string representation of the activity service template ID. This is used to identify the service for which a message is to be created.
atid - A string representation of the activity template ID. This is used to identify the activity the service belongs to.
messageTypeName - The name of the message type for which a message is to be created. Refer to ActivityServiceTemplateData.getInputMessageTypeName().

Returns:
ClientObjectWrapper - The message created. An empty client object wrapper is returned, when the specified message type cannot be found for the activity service.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1

createMessage

public ClientObjectWrapper createMessage(VTID vtid,
                                         ATID atid,
                                         java.lang.String messageTypeName)
                                  throws EngineNotAuthorizedException,
                                         IdWrongFormatException,
                                         ObjectDoesNotExistException,
                                         UnexpectedFailureException,
                                         java.rmi.RemoteException,
                                         javax.ejb.EJBException
Creates a message defined by the specified activity service using object IDs. For example, creates a message that can be used when calling a service.

The caller must have at least reader authority for the associated process template.

Specified by:
createMessage in interface BusinessFlowManagerService
Parameters:
vtid - The object ID of the activity service template for which a message is to be created.
atid - The object ID of the activity the activity service template belongs to.
messageTypeName - The name of the message type for which a message is to be created. Refer to ActivityServiceTemplateData.getInputMessageTypeName().

Returns:
ClientObjectWrapper - The message created. An empty client object wrapper is returned, when the specified message type cannot be found for the activity service.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1

getCustomProperty

public java.lang.String getCustomProperty(java.lang.String identifier,
                                          java.lang.String propertyName)
                                   throws EngineNotAuthorizedException,
                                          EngineParameterNullException,
                                          EngineWrongKindException,
                                          EngineWrongStateException,
                                          IdWrongFormatException,
                                          IdWrongTypeException,
                                          ObjectDoesNotExistException,
                                          UnexpectedFailureException,
                                          java.rmi.RemoteException,
                                          javax.ejb.EJBException
Retrieves the named custom property of the specified process template, process instance, or activity instance using a string representation of the object ID.

Custom properties allow a user to add additional properties to processes and activities, beyond those provided and managed by the process engine. Custom properties are an extension to the BPEL notion of properties. While the value of BPEL properties can only be derived from messages, the value of custom properties can also be set in the process model during deployment or at runtime for process instances and activities.

A custom property can be retrieved in any execution state of the process or activity instance. The caller must have at least reader authority for the process template, the process instance or activity instance.

Specified by:
getCustomProperty in interface BusinessFlowManagerService
Parameters:
identifier - A string representation of the process template, process instance, or activity instance object ID. This string is used to identify the object for which the custom property is to be retrieved.
propertyName - The name of the custom property for which the value is to be retrieved.

Returns:
String - The value of the specified custom property. Returns null if the specified property cannot be found.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getCustomProperty

public java.lang.String getCustomProperty(PTID ptid,
                                          java.lang.String propertyName)
                                   throws EngineNotAuthorizedException,
                                          EngineParameterNullException,
                                          EngineWrongKindException,
                                          IdWrongFormatException,
                                          ObjectDoesNotExistException,
                                          UnexpectedFailureException,
                                          java.rmi.RemoteException,
                                          javax.ejb.EJBException
Retrieves the named custom property of the specified process template using the process template ID.

Custom properties allow a user to add additional properties to a process, beyond those provided and managed by the process engine. Custom properties are an extension to the BPEL notion of properties. While the value of BPEL properties can only be derived from messages, the value of custom properties can also be set in the process model during deployment.

The caller must be authorized for the process template.

Specified by:
getCustomProperty in interface BusinessFlowManagerService
Parameters:
ptid - The process template object ID whose named custom property is to be retrieved.
propertyName - The name of the custom property for which the value is to be read.

Returns:
String - The value of the specified custom property. Returns null if the specified property cannot be found.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getCustomProperty

public java.lang.String getCustomProperty(PIID piid,
                                          java.lang.String propertyName)
                                   throws EngineNotAuthorizedException,
                                          EngineParameterNullException,
                                          EngineWrongStateException,
                                          IdWrongFormatException,
                                          ObjectDoesNotExistException,
                                          UnexpectedFailureException,
                                          java.rmi.RemoteException,
                                          javax.ejb.EJBException
Retrieves the named custom property of the specified process instance using the process instance ID.

Custom properties allow a user to add additional properties to a process, beyond those provided and managed by the process engine. Custom properties are an extension to the BPEL notion of properties. While the value of BPEL properties can only be derived from messages, the value of custom properties can also be set in the process model during deployment or at runtime for process instances and activities.

Custom property can be retrieved in any execution state of the process instance. The caller must have at least reader authority for the process instance.

Specified by:
getCustomProperty in interface BusinessFlowManagerService
Parameters:
piid - The process instance object ID for which the named custom property is to be retrieved.
propertyName - The name of the custom property for which the value is to be retrieved.

Returns:
String - The value of the specified custom property. Returns null if the specified property cannot be found.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getCustomProperty

public java.lang.String getCustomProperty(AIID aiid,
                                          java.lang.String propertyName)
                                   throws EngineNotAuthorizedException,
                                          EngineParameterNullException,
                                          EngineWrongKindException,
                                          EngineWrongStateException,
                                          IdWrongFormatException,
                                          ObjectDoesNotExistException,
                                          UnexpectedFailureException,
                                          java.rmi.RemoteException,
                                          javax.ejb.EJBException
Retrieves the named custom property of the specified activity instance using the activity instance ID.

Custom properties allow a user to add additional properties to an activity, beyond those provided and managed by the process engine. Custom properties are an extension to the BPEL notion of properties. While the value of BPEL properties can only be derived from messages, the value of custom properties can also be set in the process model during deployment or at runtime for process instances and activities.

A custom property can be retrieved in any execution state of the activity and associated process instance. The caller must have at least reader authority for the activity instance or for the associated process instance.

Specified by:
getCustomProperty in interface BusinessFlowManagerService
Parameters:
aiid - The activity instance object ID whose named custom property is to be retrieved.
propertyName - The name of the custom property for which the value is to be read.

Returns:
String - The value of the specified custom property. Returns null if the specified property cannot be found.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getCustomProperties

public java.util.List getCustomProperties(java.lang.String identifier)
                                   throws EngineNotAuthorizedException,
                                          EngineWrongKindException,
                                          EngineWrongStateException,
                                          IdWrongFormatException,
                                          IdWrongTypeException,
                                          ObjectDoesNotExistException,
                                          UnexpectedFailureException,
                                          java.rmi.RemoteException,
                                          javax.ejb.EJBException
Retrieves the custom properties of the specified process instance or activity instance using a string representation of the object ID.

Custom properties allow a user to add additional properties to processes and activities, beyond those provided and managed by the process engine. Custom properties are an extension to the BPEL notion of properties. While the value of BPEL properties can only be derived from messages, the value of custom properties can also be set in the process model during deployment or at runtime for process instances and activities.

Custom properties can be retrieved in any execution state of the process or activity instance. The caller must have at least reader authority for the process or activity instance.

Specified by:
getCustomProperties in interface BusinessFlowManagerService
Parameters:
identifier - A string representation of the process instance or activity instance object ID. This string is used to identify the object for which the custom properties are to be retrieved.

Returns:
List - A list of CustomProperty objects containing the name and value pairs. The list is empty if there are no custom properties.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

getCustomProperties

public java.util.List getCustomProperties(PIID piid)
                                   throws EngineNotAuthorizedException,
                                          EngineWrongKindException,
                                          EngineWrongStateException,
                                          IdWrongFormatException,
                                          ObjectDoesNotExistException,
                                          UnexpectedFailureException,
                                          java.rmi.RemoteException,
                                          javax.ejb.EJBException
Retrieves the custom properties of the specified process instance using the process instance ID.

Custom properties allow a user to add additional properties to an process, beyond those provided and managed by the process engine. Custom properties are an extension to the BPEL notion of properties. While the value of BPEL properties can only be derived from messages, the value of custom properties can also be set in the process model during deployment or at runtime for process instances and activities.

Custom properties can be retrieved in any execution state of the process instance. The caller must have at least reader authority for the process instance.

Specified by:
getCustomProperties in interface BusinessFlowManagerService
Parameters:
piid - The process instance object ID whose custom properties are to be retrieved.

Returns:
List - A list of CustomProperty objects containing the name and value pairs. The list is empty if there are no custom properties.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

getCustomProperties

public java.util.List getCustomProperties(AIID aiid)
                                   throws EngineNotAuthorizedException,
                                          EngineWrongKindException,
                                          EngineWrongStateException,
                                          IdWrongFormatException,
                                          ObjectDoesNotExistException,
                                          UnexpectedFailureException,
                                          java.rmi.RemoteException,
                                          javax.ejb.EJBException
Retrieves the custom properties of the specified activity instance using the activity instance ID.

Custom properties allow a user to add additional properties to an activity, beyond those provided and managed by the process engine. Custom properties are an extension to the BPEL notion of properties. While the value of BPEL properties can only be derived from messages, the value of custom properties can also be set in the process model during deployment or at runtime for process instances and activities.

Custom properties can be retrieved in any execution state of the activity and associated process instance. The caller must have at least reader authority for the activity instance or for the associated process instance.

Specified by:
getCustomProperties in interface BusinessFlowManagerService
Parameters:
aiid - The activity instance object ID whose custom properties are to be retrieved.

Returns:
List - A list of CustomProperty objects containing the name and value pairs. The list is empty if there are no custom properties.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

getCustomPropertyNames

public java.util.List getCustomPropertyNames(java.lang.String identifier)
                                      throws EngineNotAuthorizedException,
                                             IdWrongFormatException,
                                             IdWrongTypeException,
                                             ObjectDoesNotExistException,
                                             UnexpectedFailureException,
                                             java.rmi.RemoteException,
                                             javax.ejb.EJBException
Retrieves the custom property names of the specified process instance or activity instance using a string representation of the object ID.

The process instance or activity instance can be in any execution state. The caller must have at least reader authority for the process or activity instance.

Specified by:
getCustomPropertyNames in interface BusinessFlowManagerService
Parameters:
identifier - A string representation of the process instance or activity instance object ID. This string is used to identify the object for which the custom properties are to be retrieved.

Returns:
List - A list of custom property names. The list is empty, if there are no custom properties.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

getCustomPropertyNames

public java.util.List getCustomPropertyNames(PIID piid)
                                      throws EngineNotAuthorizedException,
                                             IdWrongFormatException,
                                             ObjectDoesNotExistException,
                                             UnexpectedFailureException,
                                             java.rmi.RemoteException,
                                             javax.ejb.EJBException
Retrieves the custom property names of the specified process instance using the process instance ID.

The process instance can be in any execution state. The caller must have at least reader authority for the process instance.

Specified by:
getCustomPropertyNames in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance.

Returns:
List - An list of custom property names. The list is empty, if there are no custom properties.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

getCustomPropertyNames

public java.util.List getCustomPropertyNames(AIID aiid)
                                      throws EngineNotAuthorizedException,
                                             IdWrongFormatException,
                                             ObjectDoesNotExistException,
                                             UnexpectedFailureException,
                                             java.rmi.RemoteException,
                                             javax.ejb.EJBException
Retrieves the custom property names of the specified activity instance using the activity instance ID.

The activity instance can be in any execution state. The caller must have at least reader authority for the activity instance.

Specified by:
getCustomPropertyNames in interface BusinessFlowManagerService
Parameters:
aiid - The object ID of the activity instance.

Returns:
List - An list of custom property names. The list is empty, if there are no custom properties.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

setCustomProperty

public void setCustomProperty(java.lang.String identifier,
                              java.lang.String propertyName,
                              java.lang.String propertyValue)
                       throws EngineNotAuthorizedException,
                              EngineParameterNullException,
                              EngineWrongKindException,
                              EngineWrongStateException,
                              IdWrongFormatException,
                              IdWrongTypeException,
                              InvalidLengthException,
                              ObjectDoesNotExistException,
                              UnexpectedFailureException,
                              java.rmi.RemoteException,
                              javax.ejb.EJBException
Stores custom-specific values for the specified process or activity instance using a string representation of the object ID.

Custom properties allow a user to add additional properties to processes and activities, beyond those provided and managed by the process engine. Custom properties are an extension to the BPEL notion of properties. While the value of BPEL properties can only be derived from messages, the value of custom properties can also be set in the process model during deployment or at runtime for process instances and activities.

A custom property has a name and a value of type string.

Custom properties can be provided in any execution state of the process instance. The caller must be the starter or an administrator of the process instance.

Custom properties can be provided in any execution state of the activity instance. The caller must have editor authority for the activity instance, be the owner of the activity instance, or be the administrator of the associated process instance.

Specified by:
setCustomProperty in interface BusinessFlowManagerService
Parameters:
identifier - A string representation of the process or activity instance object ID that is used to identify the process or activity instance.
propertyName - The name of the custom property to be set. The name must not be greater than 220 bytes in UTF-8 format.
propertyValue - The custom value to be set. The value must not be greater than 254 bytes in UTF-8 format.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

setCustomProperty

public void setCustomProperty(PIID piid,
                              java.lang.String propertyName,
                              java.lang.String propertyValue)
                       throws EngineNotAuthorizedException,
                              EngineParameterNullException,
                              EngineWrongKindException,
                              EngineWrongStateException,
                              IdWrongFormatException,
                              InvalidLengthException,
                              ObjectDoesNotExistException,
                              UnexpectedFailureException,
                              java.rmi.RemoteException,
                              javax.ejb.EJBException
Stores custom specific values for the specified process instance using the process instance ID.

Custom properties allow a user to add additional properties to processes and activities, beyond those provided and managed by the process engine. Custom properties are an extension to the BPEL notion of properties. While the value of BPEL properties can only be derived from messages, the value of custom properties can also be set in the process model during deployment or at runtime for process instances and activities.

A custom property has a name and a value of type string.

The process instance can be in any execution state. The caller must be the starter or an administrator of the process instance.

Specified by:
setCustomProperty in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance for which the custom property is set.
propertyName - The name of the custom property to be set. The name must not be greater than 220 bytes in UTF-8 format.
propertyValue - The custom value to be set. The value must not be greater than 254 bytes in UTF-8 format.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

setCustomProperty

public void setCustomProperty(AIID aiid,
                              java.lang.String propertyName,
                              java.lang.String propertyValue)
                       throws EngineNotAuthorizedException,
                              EngineParameterNullException,
                              EngineWrongKindException,
                              EngineWrongStateException,
                              IdWrongFormatException,
                              InvalidLengthException,
                              ObjectDoesNotExistException,
                              UnexpectedFailureException,
                              java.rmi.RemoteException,
                              javax.ejb.EJBException
Stores custom-specific values for the specified activity instance using the activity instance ID.

Custom properties allow a user to add additional properties to activities, beyond those provided and managed by the process engine. Custom properties are an extension to the BPEL notion of properties. While the value of BPEL properties can only be derived from messages, the value of custom properties can also be set in the process model during deployment or at runtime for process instances and activities.

A custom property has a name and a value of type string.

The activity instance can be in any execution state. The caller must have editor authority for the activity instance, be the owner of the activity instance, or be the administrator of the associated process instance.

Specified by:
setCustomProperty in interface BusinessFlowManagerService
Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance.
propertyName - The name of the custom property to be set. The name must not be greater than 220 bytes in UTF-8 format.
propertyValue - The custom value to be set. The value must not be greater than 254 bytes in UTF-8 format.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

claim

public ClientObjectWrapper claim(java.lang.String aiid)
                          throws EngineCannotCreateWorkItemException,
                                 EngineNotAuthorizedException,
                                 EngineWrongKindException,
                                 EngineWrongStateException,
                                 IdWrongFormatException,
                                 IdWrongTypeException,
                                 InvalidLengthException,
                                 ObjectDoesNotExistException,
                                 UnexpectedFailureException,
                                 WorkItemManagerException,
                                 java.rmi.RemoteException,
                                 javax.ejb.EJBException
Claims a ready activity instance for user processing using a string representation of the activity instance ID.

The activity instance must be a staff activity instance and be in the ready execution state. The associated process instance must be in the running execution state.

The caller must be a potential owner of the activity instance or an administrator of the associated process instance.

The execution state of the activity instance is changed to claimed. Refer to complete for information on how to complete an activity instance.

Specified by:
claim in interface BusinessFlowManagerService
Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance to be claimed.

Returns:
ClientObjectWrapper - The input message of the claimed activity instance.

Throws:
EngineCannotCreateWorkItemException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

claim

public ClientObjectWrapper claim(AIID aiid)
                          throws EngineCannotCreateWorkItemException,
                                 EngineNotAuthorizedException,
                                 EngineWrongKindException,
                                 EngineWrongStateException,
                                 IdWrongFormatException,
                                 InvalidLengthException,
                                 ObjectDoesNotExistException,
                                 UnexpectedFailureException,
                                 WorkItemManagerException,
                                 java.rmi.RemoteException,
                                 javax.ejb.EJBException
Claims a ready activity instance for user processing using the activity instance ID.

The activity instance must be a staff activity instance and be in the ready execution state. The associated process instance must be in the running execution state.

The caller must be a potential owner of the activity instance or an administrator of the associated process instance.

The execution state of the activity instance is changed to claimed. Refer to complete for information on how to complete an activity instance.

Specified by:
claim in interface BusinessFlowManagerService
Parameters:
aiid - The object ID of the activity instance to be claimed.

Returns:
ClientObjectWrapper - The input message of the claimed activity instance.

Throws:
EngineCannotCreateWorkItemException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

claim

public ActivityInstanceData claim(java.lang.String whereClause,
                                  java.lang.String orderByClause,
                                  java.util.TimeZone timeZone)
                           throws EngineCannotCreateWorkItemException,
                                  EngineNotAuthorizedException,
                                  UnexpectedFailureException,
                                  WorkItemManagerException,
                                  java.rmi.RemoteException,
                                  javax.ejb.EJBException
Claims a ready activity instance for user processing.

The activity instance that is claimed is identified by the specified where- and order-by-clauses, and by the following conditions:

It must be a staff activity in the ready execution state and the the caller must be a potential owner of the activity instance or an administrator of the associated process instance.

The first activity instance that qualifies under these conditions is claimed.

Refer to complete for information on how to complete an activity instance.

Specified by:
claim in interface BusinessFlowManagerService
Parameters:
whereClause - The search condition to be applied to the query domain. The search condition is used to filter the set of ready staff activities that can be claimed by the logged-on user. Its syntax is an SQL where-clause. The following rules apply:
  • Specify object ID constants as ID('string-rep-of-oid').
  • Specify timestamp constants as TS('yyyy-mm-ddThh:mm:ss') or as CURRENT_DATE for comparisons with the current date.
    The date and time parts of a TS definition are optional; either the date or the time must be specified. If no date part of a TS definition is specified, the current date is taken. Optional time values that are not specified are set to zero. The timestamp is 24 hours based. For example, TS('16:04') is the same as TS('2002-12-24T16:04:00') provided that the current date is December 24th, 2002.
    If a date part of a TS definition is specified, the year must consist of 4 letters; the month and day specifications are optional. Missing month and day specifications are set to 01. For example, specifying TS('2003') is the same as specifying TS('2003-01-01T00:00:00').
  • Specify binary constants as BIN('UTF-8 string').
  • Use constants instead of integer enumerations. For example, instead of specifying an activity state expression "ACTIVITY.STATE=2" , specify "ACTIVITY.STATE=ACTIVITY.STATE.STATE_READY".
  • Duplicate apostrophes (') in comparising values. For example, "ACTIVITY.NAME='d''automatisation'".
  • To specify a where clause that refers to properties of name-value pairs, like custom properties, add a one-digit suffix (0-9) to the view name.
    For example, to have only tuples returned where an activity custom property "prop1" has the value "v1" or where an activity custom property "prop2" has the value v2", the where clause can look like "ACTIVITY_ATTRIBUTE1.NAME='prop1' AND ACTIVITY_ATTRIBUTE1.VALUE='v1' OR ACTIVITY_ATTRIBUTE2.NAME='prop2' AND ACTIVITY_ATTRIBUTE2.VALUE = 'v2'". For performance reasons, you should not use more than one "OR" construct; use "IN" instead.
    For example, to retrieve the values of custom properties "prop1" and "prop2" of all activity instances, the select clause can look like "DISTINCT ACTIVITY.AIID, ACTIVITY_ATTRIBUTE1.VALUE, ACTIVITY_ATTRIBUTE2.VALUE" and the where-clause "ACTIVITY_ATTRIBUTE1.NAME = 'prop1' AND ACTIVITY_ATTRIBUTE2.NAME = 'prop2'".

If a filter is not to be applied, null must be specified.

orderByClause - Sorts the query result set by the values of the columns you identify. The orderby-clause sorts the set of qualifying ready activities; the first activity of the sorted result is claimed. Its syntax is an SQL order-by-clause. Each comma separated part of the order-by-clause must specify a property from the published process views - see the InfoCenter for details.

If you identify more that one property, the query result set is ordered by the values of the first property you identify, then by the values of the second property, and so on.

If sort criteria are not to be applied, null must be specified.

Note that sort criteria are applied on the server, that is, the locale of the server is used for sorting.

timeZone - Specifies the time zone of the timestamp constants in the whereClause. If a timezone is not specified, UTC is assumed.

Returns:
ActivityInstanceData - The activity instance that is claimed. If there is no ready activity instance that qualifies, null is returned. Refer to ActivityInstanceData to view the activity instance properties.

Throws:
EngineCannotCreateWorkItemException
EngineNotAuthorizedException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1.1

cancelClaim

public void cancelClaim(java.lang.String aiid)
                 throws EngineNotAuthorizedException,
                        EngineWrongKindException,
                        EngineWrongStateException,
                        IdWrongFormatException,
                        IdWrongTypeException,
                        ObjectDoesNotExistException,
                        UnexpectedFailureException,
                        WorkItemManagerException,
                        java.rmi.RemoteException,
                        javax.ejb.EJBException
Cancels the claim of an activity instance using a string representation of the activity instance ID.

The activity instance must have been claimed. It is returned to the ready execution state. Any previously stored output or fault message is deleted.

The associated process instance must be in the running, failing, or terminating execution state. The caller must be the owner of the activity instance or an administrator of the associated process instance.

Specified by:
cancelClaim in interface BusinessFlowManagerService
Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

cancelClaim

public void cancelClaim(AIID aiid)
                 throws EngineNotAuthorizedException,
                        EngineWrongKindException,
                        EngineWrongStateException,
                        IdWrongFormatException,
                        ObjectDoesNotExistException,
                        UnexpectedFailureException,
                        WorkItemManagerException,
                        java.rmi.RemoteException,
                        javax.ejb.EJBException
Cancels the claim of an activity instance using the activity instance ID.

The activity instance must have been claimed. It is returned to the ready execution state. Any previously stored output or fault message is deleted.

The associated process instance must be in the running, failing, or terminating execution state. The caller must be the owner of the activity instance or an administrator of the associated process instance.

Specified by:
cancelClaim in interface BusinessFlowManagerService
Parameters:
aiid - The activity instance object ID that is used to identify the activity instance.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

complete

public void complete(java.lang.String aiid)
              throws EngineNotAuthorizedException,
                     EngineWrongKindException,
                     EngineWrongStateException,
                     IdWrongFormatException,
                     IdWrongTypeException,
                     ObjectDoesNotExistException,
                     UnexpectedFailureException,
                     java.rmi.RemoteException,
                     javax.ejb.EJBException
Completes a claimed activity instance using a string representation of the activity instance ID.

The activity instance must be in the claimed execution state and the associated process instance must be in the running, failing, or terminating execution state.

The caller must be the owner of the activity instance or an administrator of the associated process instance.

Completion of an activity instance means that user processing has finished and that navigation of the process instance can continue. If user processing completed successfully, the activity instance is put into the finished execution state.

If user processing did not complete successfully, that is, if a fault message is set, the activity instance is put into the failed or stopped execution state depending on the process instance "continue on error" flag. If set into the failed execution state and if the fault is not handled, the associated process instance is put into the finished execution state or the failed execution state if the fault is also not handled there.

Output or fault message values are used to continue navigation.

Note that an output or fault message does not need to be set; navigation can continue with an empty message.

Specified by:
complete in interface BusinessFlowManagerService
Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance to be completed.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

complete

public void complete(AIID aiid)
              throws EngineNotAuthorizedException,
                     EngineWrongKindException,
                     EngineWrongStateException,
                     IdWrongFormatException,
                     ObjectDoesNotExistException,
                     UnexpectedFailureException,
                     java.rmi.RemoteException,
                     javax.ejb.EJBException
Completes a claimed activity instance using the activity instance ID.

The activity instance must be in the claimed execution state and the associated process instance must be in the running, failing, or terminating execution state.

The caller must be the owner of the activity instance or an administrator of the associated process instance.

Completion of an activity instance means that user processing has finished and that navigation of the process instance can continue. If user processing completed successfully, the activity instance is put into the finished execution state.

If user processing did not complete successfully, that is, if a fault message is set, the activity instance is put into the failed or stopped execution state depending on the process instance "continue on error" flag. If set into the failed execution state and if the fault is not handled, the associated process instance is put into the finished execution state or the failed execution state if the fault is also not handled there.

Output or fault message values are used to continue navigation.

Note that an output or fault message does not need to be set; navigation can continue with an empty message.

Specified by:
complete in interface BusinessFlowManagerService
Parameters:
aiid - The object ID to identify the activity instance to be completed.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

complete

public void complete(AIID aiid,
                     ClientObjectWrapper output)
              throws EngineNotAuthorizedException,
                     EngineParameterNullException,
                     EngineWrongKindException,
                     EngineWrongMessageTypeException,
                     EngineWrongStateException,
                     IdWrongFormatException,
                     ObjectDoesNotExistException,
                     UnexpectedFailureException,
                     java.rmi.RemoteException,
                     javax.ejb.EJBException
Completes a claimed activity instance using the activity instance ID and passes the result of user processing.

The activity instance must be in the claimed execution state and the associated process instance must be in the running, failing, or terminating execution state.

The caller must be the owner of the activity instance or an administrator of the associated process instance.

Completion of an activity instance means that user processing finished and that navigation of the process instance can continue. An output message is passed to denote the successful execution of user processing. The activity instance is put into the finished execution state.

When finished, output message values are used to continue navigation.

Specified by:
complete in interface BusinessFlowManagerService
Parameters:
aiid - The object ID to identify the activity instance to be completed.
output - The output message that denotes the result of processing. An object wrapped by the ClientObjectWrapper must be serializable.

Any previously set output or fault message is ignored.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

complete

public void complete(java.lang.String aiid,
                     ClientObjectWrapper output)
              throws EngineNotAuthorizedException,
                     EngineParameterNullException,
                     EngineWrongKindException,
                     EngineWrongMessageTypeException,
                     EngineWrongStateException,
                     IdWrongFormatException,
                     IdWrongTypeException,
                     ObjectDoesNotExistException,
                     UnexpectedFailureException,
                     java.rmi.RemoteException,
                     javax.ejb.EJBException
Completes a claimed activity instance using a string representation of the activity instance ID and passes the result of user processing.

The activity instance must be in the claimed execution state and the associated process instance must be in the running, failing, or terminating execution state.

The caller must be the owner of the activity instance or an administrator of the associated process instance.

Completion of an activity instance means that user processing finished and that navigation of the process instance can continue. An output message is passed to denote the successful execution of user processing. The activity instance is put into the finished execution state.

When finished, output message values are used to continue navigation.

Specified by:
complete in interface BusinessFlowManagerService
Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance to be completed.
output - The output message that denotes the result of processing. An object wrapped by the ClientObjectWrapper must be serializable.

Any previously set output or fault message is ignored.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

complete

public void complete(AIID aiid,
                     ClientObjectWrapper faultMessage,
                     java.lang.String faultName)
              throws EngineNotAuthorizedException,
                     EngineParameterNullException,
                     EngineWrongKindException,
                     EngineWrongMessageTypeException,
                     EngineWrongStateException,
                     IdWrongFormatException,
                     ObjectDoesNotExistException,
                     UnexpectedFailureException,
                     java.rmi.RemoteException,
                     javax.ejb.EJBException
Completes a claimed activity instance using the activity instance ID and denotes the failing of user processing.

The activity instance must be in the claimed execution state and the associated process instance must be in the running, failing, or terminating execution state.

The caller must be the owner of the activity instance or an administrator of the associated process instance.

Completion of an activity instance means that user processing finished and that navigation of the process instance can continue. A fault message is passed to denote the unsuccessful execution of user processing. The activity instance is put into the stopped execution state when the fault is not handled and when the "continue on error" flag of the associated process instance is set. Otherwise, it is set into the failed execution state. If set into the failed execution state and if the fault is not handled, the associated process instance is put into the finished execution state or the failed execution state if the fault is also not handled there.

Fault message values are used to continue navigation.

Specified by:
complete in interface BusinessFlowManagerService
Parameters:
aiid - The object ID to identify the activity instance to be completed.
faultMessage - The fault message. The object wrapped by the ClientObjectWrapper must be serializable. Any previously set output or fault message is ignored.
faultName - A fault to denote unsuccessful processing. Must be a fault defined for the activity. Refer to getFaultNames. Note that the structure of a BPEL fault name is a QName.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

complete

public void complete(java.lang.String aiid,
                     ClientObjectWrapper faultMessage,
                     java.lang.String faultName)
              throws EngineNotAuthorizedException,
                     EngineParameterNullException,
                     EngineWrongKindException,
                     EngineWrongMessageTypeException,
                     EngineWrongStateException,
                     IdWrongFormatException,
                     IdWrongTypeException,
                     ObjectDoesNotExistException,
                     UnexpectedFailureException,
                     java.rmi.RemoteException,
                     javax.ejb.EJBException
Completes a claimed activity instance using a string representation of the activity instance ID and denotes the failing of user processing.

The activity instance must be in the claimed execution state and the associated process instance must be in the running, failing, or terminating execution state.

The caller must be the owner of the activity instance or an administrator of the associated process instance.

Completion of an activity instance means that user processing finished and that navigation of the process instance can continue. A fault message is passed to denote the unsuccessful execution of user processing. The activity instance is put into the stopped execution state when the fault is not handled and when the "continue on error" flag of the associated process instance is set. Otherwise, it is set into the failed execution state. If set into the failed execution state and if the fault is not handled, the associated process instance is put into the finished execution state or the failed execution state if the fault is also not handled there.

Fault message values are used to continue navigation.

Specified by:
complete in interface BusinessFlowManagerService
Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance to be completed.
faultMessage - The fault message. The object wrapped by the ClientObjectWrapper must be serializable. Any previously set output or fault message is ignored.
faultName - A fault to denote unsuccessful processing. Must be a fault defined for the activity. Refer to getFaultNames. Note that the structure of a BPEL fault name is a QName.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

call

public ClientObjectWrapper call(java.lang.String processTemplateName,
                                ClientObjectWrapper inputMessage)
                         throws CreateFailedException,
                                EngineAdministratorCannotBeResolvedException,
                                EngineCannotCreateWorkItemException,
                                EngineCannotInitializeVariableException,
                                EngineCannotOpenCompensationSphereException,
                                EngineCannotRunSynchronousException,
                                EngineNotAuthorizedException,
                                EngineProcessCompensatedException,
                                EngineProcessModelDoesNotExistException,
                                EngineProcessModelStoppedException,
                                EngineWrongMessageTypeException,
                                FaultReplyException,
                                InvalidLengthException,
                                ProcessException,
                                ServiceNotUniqueException,
                                UnexpectedFailureException,
                                java.rmi.RemoteException,
                                javax.ejb.EJBException
Creates and executes a process instance that is derived from the specified process template. An input message can be passed to specify initial values for the process instance.

This method returns only when the execution of the process instance finishes with the result of execution. If a fault occurs, an exception is thrown.

The process template must specify that derived process instances can run synchronously, that is, as a microflow and must return a reply. A BPEL process must start with a single receive or pick activity. The pick activity must specify a single onMessage so that the service to be called can be identified.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

Specified by:
call in interface BusinessFlowManagerService
Parameters:
processTemplateName - The name of the process template for which an instance is to be created and executed.
inputMessage - The input message that specifies the initial values of the process instance. If input is not to be provided, null must be specified. The object wrapped by the ClientObjectWrapper must be serializable.

Returns:
ClientObjectWrapper - The output message that denotes the result of execution.

Throws:
CreateFailedException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotRunSynchronousException
EngineNotAuthorizedException
EngineProcessCompensatedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineWrongMessageTypeException
FaultReplyException
InvalidLengthException
ProcessException
ServiceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

call

public ClientObjectWrapper call(java.lang.String vtid,
                                java.lang.String atid,
                                ClientObjectWrapper inputMessage)
                         throws CreateFailedException,
                                EngineCannotRunSynchronousException,
                                EngineNotAuthorizedException,
                                EngineProcessModelDoesNotExistException,
                                EngineProcessModelStoppedException,
                                FaultReplyException,
                                IdWrongFormatException,
                                IdWrongTypeException,
                                ObjectDoesNotExistException,
                                ProcessException,
                                UnexpectedFailureException,
                                java.rmi.RemoteException,
                                javax.ejb.EJBException
Creates and executes a process instance using a string representation of the activity service template ID and the activity template ID. An input message can be passed to specify initial values for the process instance.

This method returns only when the execution of the process instance finishes with the result of execution. If a fault occurs, an exception is thrown.

The process template must specify that derived process instances can run synchronously, that is, as a microflow and must return a reply.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

Specified by:
call in interface BusinessFlowManagerService
Parameters:
vtid - The string representation of the activity service template object ID. This is used to identify the starting service to be called.
atid - A string representation of the activity template ID. This is used to identify the activity the service belongs to.
inputMessage - The input message that specifies the initial values of the process instance. If input is not to be provided, null must be specified. The object wrapped by the ClientObjectWrapper must be serializable.

Returns:
ClientObjectWrapper - The output message that denotes the result of execution.

Throws:
CreateFailedException
EngineCannotRunSynchronousException
EngineNotAuthorizedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
FaultReplyException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
ProcessException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1.1

call

public ClientObjectWrapper call(VTID vtid,
                                ATID atid,
                                ClientObjectWrapper inputMessage)
                         throws CreateFailedException,
                                EngineCannotRunSynchronousException,
                                EngineNotAuthorizedException,
                                EngineProcessModelDoesNotExistException,
                                EngineProcessModelStoppedException,
                                FaultReplyException,
                                IdWrongFormatException,
                                IdWrongTypeException,
                                ObjectDoesNotExistException,
                                ProcessException,
                                UnexpectedFailureException,
                                java.rmi.RemoteException,
                                javax.ejb.EJBException
Creates and executes a process instance using the activity service template ID and the activity template ID. An input message can be passed to specify initial values for the process instance.

This method returns only when the execution of the process instance finishes with the result of execution. If a fault occurs, an exception is thrown.

The process template must specify that derived process instances can run as a microflow and must return a reply.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

Specified by:
call in interface BusinessFlowManagerService
Parameters:
vtid - The object ID of the activity service template that is used to identify the starting service to be called.
atid - The object ID of the activity the activity service template belongs to.
inputMessage - The input message that specifies the initial values of the process instance. If input is not to be provided, null must be specified. The object wrapped by the ClientObjectWrapper must be serializable.

Returns:
ClientObjectWrapper - The output message that denotes the result of execution.

Throws:
CreateFailedException
EngineCannotRunSynchronousException
EngineNotAuthorizedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
FaultReplyException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
ProcessException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1.1

callWithReplyContext

public void callWithReplyContext(java.lang.String processTemplateName,
                                 ClientObjectWrapper inputMessage,
                                 ReplyContextWrapper replyContext)
                          throws CreateFailedException,
                                 EngineAdministratorCannotBeResolvedException,
                                 EngineCannotCreateWorkItemException,
                                 EngineCannotInitializeVariableException,
                                 EngineCannotOpenCompensationSphereException,
                                 EngineCannotUnwrapReplyContextException,
                                 EngineNotAuthorizedException,
                                 EngineProcessCompensatedException,
                                 EngineProcessModelDoesNotExistException,
                                 EngineProcessModelStoppedException,
                                 EngineWrongMessageTypeException,
                                 FaultReplyException,
                                 InvalidLengthException,
                                 MissingPartsException,
                                 ProcessException,
                                 ProcessInstanceNotUniqueException,
                                 SendReplyErrorException,
                                 ServiceNotUniqueException,
                                 UnexpectedFailureException,
                                 java.rmi.RemoteException,
                                 javax.ejb.EJBException
Creates and executes a process instance from the specified process template and asynchronously waits for the result. An input message can be passed to specify initial values for the process instance.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

Specified by:
callWithReplyContext in interface BusinessFlowManagerService
Parameters:
processTemplateName - The name of the process template for which an instance is to be created and executed.
inputMessage - The input message that specifies the initial values of the process instance. If input is not to be provided, null must be specified. The object wrapped by the ClientObjectWrapper must be serializable.
replyContext - The reply context that is to be used to send the result back to the caller.

Throws:
CreateFailedException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotUnwrapReplyContextException
EngineNotAuthorizedException
EngineProcessCompensatedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineWrongMessageTypeException
FaultReplyException
InvalidLengthException
MissingPartsException
ProcessException
ProcessInstanceNotUniqueException
SendReplyErrorException
ServiceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

callWithReplyContext

public void callWithReplyContext(java.lang.String processTemplateName,
                                 java.lang.String processInstanceName,
                                 ClientObjectWrapper inputMessage,
                                 ReplyContextWrapper replyContext)
                          throws CreateFailedException,
                                 EngineAdministratorCannotBeResolvedException,
                                 EngineCannotCreateWorkItemException,
                                 EngineCannotInitializeVariableException,
                                 EngineCannotOpenCompensationSphereException,
                                 EngineCannotUnwrapReplyContextException,
                                 EngineNotAuthorizedException,
                                 EngineProcessCompensatedException,
                                 EngineProcessInstanceNameNotUniqueException,
                                 EngineProcessModelDoesNotExistException,
                                 EngineProcessModelStoppedException,
                                 EngineWrongMessageTypeException,
                                 FaultReplyException,
                                 InvalidLengthException,
                                 MissingPartsException,
                                 ProcessException,
                                 ProcessInstanceNotUniqueException,
                                 SendReplyErrorException,
                                 ServiceNotUniqueException,
                                 UnexpectedFailureException,
                                 java.rmi.RemoteException,
                                 javax.ejb.EJBException
Creates and executes a named process instance from the specified process template and asynchronously waits for the result. An input message can be passed to specify initial values for the process instance.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

Specified by:
callWithReplyContext in interface BusinessFlowManagerService
Parameters:
processTemplateName - The name of the process template for which an instance is to be created and executed.
processInstanceName - The name of the process instance to be created; must not be greater than 220 bytes in UTF-8 format. The name must be unique.
inputMessage - The input message that specifies the initial values of the process instance. If input is not to be provided, null must be specified. The object wrapped by the ClientObjectWrapper must be serializable.
replyContext - The reply context that is to be used to send the result back to the caller.

Throws:
CreateFailedException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotUnwrapReplyContextException
EngineNotAuthorizedException
EngineProcessCompensatedException
EngineProcessInstanceNameNotUniqueException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineWrongMessageTypeException
FaultReplyException
InvalidLengthException
MissingPartsException
ProcessException
ProcessInstanceNotUniqueException
SendReplyErrorException
ServiceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

callWithReplyContext

public void callWithReplyContext(java.lang.String processTemplateName,
                                 ClientObjectWrapper inputMessage,
                                 ReplyContextWrapper replyContext,
                                 int invocationCount,
                                 java.lang.String requestId)
                          throws CreateFailedException,
                                 EngineAdministratorCannotBeResolvedException,
                                 EngineCannotCreateWorkItemException,
                                 EngineCannotInitializeVariableException,
                                 EngineCannotOpenCompensationSphereException,
                                 EngineCannotUnwrapReplyContextException,
                                 EngineNotAuthorizedException,
                                 EngineProcessCompensatedException,
                                 EngineProcessModelDoesNotExistException,
                                 EngineProcessModelStoppedException,
                                 EngineWrongMessageTypeException,
                                 FaultReplyException,
                                 InvalidLengthException,
                                 MissingPartsException,
                                 ProcessException,
                                 ProcessInstanceNotUniqueException,
                                 SendReplyErrorException,
                                 ServiceNotUniqueException,
                                 UnexpectedFailureException,
                                 java.rmi.RemoteException,
                                 javax.ejb.EJBException
Creates and executes a process instance from the specified process template and asynchronously waits for the result of the uniquely identified request. An input message can be passed to specify initial values for the process instance.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

Specified by:
callWithReplyContext in interface BusinessFlowManagerService
Parameters:
processTemplateName - The name of the process template for which an instance is to be created and executed.
inputMessage - The input message that specifies the initial values of the process instance. If input is not to be provided, null must be specified. The object wrapped by the ClientObjectWrapper must be serializable.
replyContext - The reply context that is to be used to send the reply back to the caller.
invocationCount - The invocation count that specifies the number of invocation attempts. The first attempt should be 1, the second 2, and so on. This count has to be maintained by the caller and has to be incremented after each unsuccesful invocation attempt, that is, when the request ended with an exception. If the caller is an MDB that works on behalf of a received JMS message, the JMSXDeliveryCount property of the message can be used to count the invocation attempts. A value of 0 indicates that the invocation count is not known to the caller.
requestId - An ID to identify the request uniquely. If the caller is an MDB that works on behalf of a received JMS message, the JMSMessageId can be used as the requestId. A value of null implies that a unique requestId is not known to the caller.

Throws:
CreateFailedException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotUnwrapReplyContextException
EngineNotAuthorizedException
EngineProcessCompensatedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineWrongMessageTypeException
FaultReplyException
InvalidLengthException
MissingPartsException
ProcessException
ProcessInstanceNotUniqueException
SendReplyErrorException
ServiceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

callWithReplyContext

public void callWithReplyContext(java.lang.String processTemplateName,
                                 java.lang.String processInstanceName,
                                 ClientObjectWrapper inputMessage,
                                 ReplyContextWrapper replyContext,
                                 int invocationCount,
                                 java.lang.String requestId)
                          throws CreateFailedException,
                                 EngineAdministratorCannotBeResolvedException,
                                 EngineCannotCreateWorkItemException,
                                 EngineCannotInitializeVariableException,
                                 EngineCannotOpenCompensationSphereException,
                                 EngineCannotUnwrapReplyContextException,
                                 EngineNotAuthorizedException,
                                 EngineProcessCompensatedException,
                                 EngineProcessInstanceNameNotUniqueException,
                                 EngineProcessModelDoesNotExistException,
                                 EngineProcessModelStoppedException,
                                 EngineWrongMessageTypeException,
                                 FaultReplyException,
                                 InvalidLengthException,
                                 MissingPartsException,
                                 ProcessException,
                                 ProcessInstanceNotUniqueException,
                                 SendReplyErrorException,
                                 ServiceNotUniqueException,
                                 UnexpectedFailureException,
                                 java.rmi.RemoteException,
                                 javax.ejb.EJBException
Creates and executes a named process instance from the specified process template and asynchronously waits for the result of the uniquely identified request. An input message can be passed to specify initial values for the process instance.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

Specified by:
callWithReplyContext in interface BusinessFlowManagerService
Parameters:
processTemplateName - The name of the process template for which an instance is to be created and executed.
processInstanceName - The name of the process instance to be created; must not be greater than 220 bytes in UTF-8 format. The name must be unique.
inputMessage - The input message that specifies the initial values of the process instance. If input is not to be provided, null must be specified. The object wrapped by the ClientObjectWrapper must be serializable.
replyContext - The reply context that is to be used to send the reply back to the caller.
invocationCount - The invocation count that specifies the number of invocation attempts. The first attempt should be 1, the second 2, and so on. This count has to be maintained by the caller and has to be incremented after each unsuccesful invocation attempt, that is, when the request ended with an exception. If the caller is an MDB that works on behalf of a received JMS message, the JMSXDeliveryCount property of the message can be used to count the invocation attempts. A value of 0 indicates that the invocation count is not known to the caller.
requestId - An ID to identify the request uniquely. If the caller is an MDB that works on behalf of a received JMS message, the JMSMessageId can be used as the requestId. A value of null implies that a unique requestId is not known to the caller.

Throws:
CreateFailedException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotUnwrapReplyContextException
EngineNotAuthorizedException
EngineProcessCompensatedException
EngineProcessInstanceNameNotUniqueException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineWrongMessageTypeException
FaultReplyException
InvalidLengthException
MissingPartsException
ProcessException
ProcessInstanceNotUniqueException
SendReplyErrorException
ServiceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

callServiceWithReplyContext

public void callServiceWithReplyContext(java.lang.String vtid,
                                        java.lang.String atid,
                                        java.lang.String processInstanceName,
                                        ClientObjectWrapper inputMessage,
                                        ReplyContextWrapper replyContext,
                                        int invocationCount,
                                        java.lang.String requestId)
                                 throws CreateFailedException,
                                        EngineAdministratorCannotBeResolvedException,
                                        EngineCannotCreateWorkItemException,
                                        EngineCannotInitializeVariableException,
                                        EngineCannotOpenCompensationSphereException,
                                        EngineCannotUnwrapReplyContextException,
                                        EngineNotAuthorizedException,
                                        EngineProcessCompensatedException,
                                        EngineProcessInstanceNameNotUniqueException,
                                        EngineProcessModelDoesNotExistException,
                                        EngineProcessModelStoppedException,
                                        EngineWrongMessageTypeException,
                                        FaultReplyException,
                                        IdWrongFormatException,
                                        InvalidLengthException,
                                        MissingPartsException,
                                        ProcessException,
                                        ProcessInstanceNotUniqueException,
                                        SendReplyErrorException,
                                        ServiceNotUniqueException,
                                        UnexpectedFailureException,
                                        java.rmi.RemoteException,
                                        javax.ejb.EJBException
Creates and executes a process instance using the activity service template ID and the activity template ID and asynchronously waits for the result. An input message can be passed to specify initial values for the process instance.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

Specified by:
callServiceWithReplyContext in interface BusinessFlowManagerService
Parameters:
vtid - The string representation of the activity service template object ID. This is used to identify the starting service to be called.
atid - A string representation of the activity template ID. This is used to identify the activity the service belongs to.
processInstanceName - The name of the process instance to be created; must not be greater than 220 bytes in UTF-8 format. The name must be unique or can be null.
inputMessage - The input message that specifies the initial values of the process instance. If input is not to be provided, null must be specified. The object wrapped by the ClientObjectWrapper must be serializable.
replyContext - The reply context that is to be used to send the result back to the caller.

invocationCount - The invocation count that specifies the number of invocation attempts. The first attempt should be 1, the second 2, and so on. This count has to be maintained by the caller and has to be incremented after each unsuccesful invocation attempt, that is, when the request ended with an exception. If the caller is an MDB that works on behalf of a received JMS message, the JMSXDeliveryCount property of the message can be used to count the invocation attempts. A value of 0 indicates that the invocation count is not known to the caller.
requestId - An ID to identify the request uniquely. If the caller is an MDB that works on behalf of a received JMS message, the JMSMessageId can be used as the requestId. A value of null implies that a unique requestId is not known to the caller.

Throws:
CreateFailedException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotUnwrapReplyContextException
EngineNotAuthorizedException
EngineProcessCompensatedException
EngineProcessInstanceNameNotUniqueException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineWrongMessageTypeException
FaultReplyException
IdWrongFormatException
InvalidLengthException
MissingPartsException
ProcessException
ProcessInstanceNotUniqueException
SendReplyErrorException
ServiceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

callServiceWithReplyContext

public void callServiceWithReplyContext(VTID vtid,
                                        ATID atid,
                                        java.lang.String processInstanceName,
                                        ClientObjectWrapper inputMessage,
                                        ReplyContextWrapper replyContext,
                                        int invocationCount,
                                        java.lang.String requestId)
                                 throws CreateFailedException,
                                        EngineAdministratorCannotBeResolvedException,
                                        EngineCannotCreateWorkItemException,
                                        EngineCannotInitializeVariableException,
                                        EngineCannotOpenCompensationSphereException,
                                        EngineCannotUnwrapReplyContextException,
                                        EngineNotAuthorizedException,
                                        EngineProcessCompensatedException,
                                        EngineProcessInstanceNameNotUniqueException,
                                        EngineProcessModelDoesNotExistException,
                                        EngineProcessModelStoppedException,
                                        EngineWrongMessageTypeException,
                                        FaultReplyException,
                                        IdWrongFormatException,
                                        InvalidLengthException,
                                        MissingPartsException,
                                        ProcessException,
                                        ProcessInstanceNotUniqueException,
                                        SendReplyErrorException,
                                        ServiceNotUniqueException,
                                        UnexpectedFailureException,
                                        java.rmi.RemoteException,
                                        javax.ejb.EJBException
Creates and executes a process instance using the activity service template ID and the activity template ID and asynchronously waits for the result. An input message can be passed to specify initial values for the process instance.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

Specified by:
callServiceWithReplyContext in interface BusinessFlowManagerService
Parameters:
vtid - The object ID of the activity service template that is used to identify the starting service to be called.
atid - The object ID of the activity the activity service template belongs to.
processInstanceName - The name of the process instance to be created; must not be greater than 220 bytes in UTF-8 format. The name must be unique or can be null.
inputMessage - The input message that specifies the initial values of the process instance. If input is not to be provided, null must be specified. The object wrapped by the ClientObjectWrapper must be serializable.
replyContext - The reply context that is to be used to send the result back to the caller.

invocationCount - The invocation count that specifies the number of invocation attempts. The first attempt should be 1, the second 2, and so on. This count has to be maintained by the caller and has to be incremented after each unsuccesful invocation attempt, that is, when the request ended with an exception. If the caller is an MDB that works on behalf of a received JMS message, the JMSXDeliveryCount property of the message can be used to count the invocation attempts. A value of 0 indicates that the invocation count is not known to the caller.
requestId - An ID to identify the request uniquely. If the caller is an MDB that works on behalf of a received JMS message, the JMSMessageId can be used as the requestId. A value of null implies that a unique requestId is not known to the caller.

Throws:
CreateFailedException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotUnwrapReplyContextException
EngineNotAuthorizedException
EngineProcessCompensatedException
EngineProcessInstanceNameNotUniqueException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineWrongMessageTypeException
FaultReplyException
IdWrongFormatException
InvalidLengthException
MissingPartsException
ProcessException
ProcessInstanceNotUniqueException
SendReplyErrorException
ServiceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

callWithUISettings

public ProcessResponseWrapper callWithUISettings(java.lang.String processTemplateName,
                                                 ClientObjectWrapper inputMessage)
                                          throws CreateFailedException,
                                                 EngineCannotRunSynchronousException,
                                                 EngineNotAuthorizedException,
                                                 EngineProcessModelDoesNotExistException,
                                                 EngineProcessModelStoppedException,
                                                 FaultReplyException,
                                                 ProcessException,
                                                 ServiceNotUniqueException,
                                                 UnexpectedFailureException,
                                                 java.rmi.RemoteException,
                                                 javax.ejb.EJBException
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. An input message can be passed to specify initial values for the process instance.

This method returns only when the execution of the process instance finishes with the result of execution. If a fault occurs, an exception is thrown.

The process template must specify that derived process instances can run as a microflow and must return a reply. The process must start with a single receive or pick activity. The pick activity must specify a single onMessage so that the service to be called can be identified.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

Specified by:
callWithUISettings in interface BusinessFlowManagerService
Parameters:
processTemplateName - The name of the process template for which an instance is to be created and executed.
inputMessage - The input message that specifies the initial values of the process instance. If input is not to be provided, null must be specified. The object wrapped by the ClientObjectWrapper must be serializable.

Returns:
ProcessResponseWrapper - The output message that denotes the result of execution and its client UI settings - refer to ProcessResponseWrapper.

Throws:
CreateFailedException
EngineCannotRunSynchronousException
EngineNotAuthorizedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
FaultReplyException
ProcessException
ServiceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1.1 - FDML related exceptions removed

callWithUISettings

public ProcessResponseWrapper callWithUISettings(java.lang.String vtid,
                                                 java.lang.String atid,
                                                 ClientObjectWrapper inputMessage)
                                          throws CreateFailedException,
                                                 EngineCannotRunSynchronousException,
                                                 EngineNotAuthorizedException,
                                                 EngineProcessModelDoesNotExistException,
                                                 EngineProcessModelStoppedException,
                                                 FaultReplyException,
                                                 IdWrongFormatException,
                                                 IdWrongTypeException,
                                                 ObjectDoesNotExistException,
                                                 ProcessException,
                                                 ServiceNotUniqueException,
                                                 UnexpectedFailureException,
                                                 java.rmi.RemoteException,
                                                 javax.ejb.EJBException
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. An input message can be passed to specify initial values for the process instance.

This method returns only when the execution of the process instance finishes with the result of execution. If a fault occurs, an exception is thrown.

The process template must specify that derived process instances can run as a microflow and must return a reply.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

Specified by:
callWithUISettings in interface BusinessFlowManagerService
Parameters:
vtid - The string representation of the activity service template object ID. This is used to identify the starting service to be called.
atid - A string representation of the activity template ID. This is used to identify the activity the service belongs to.
inputMessage - The input message that specifies the initial values of the process instance. If input is not to be provided, null must be specified. The object wrapped by the ClientObjectWrapper must be serializable.

Returns:
ProcessResponseWrapper - The output message that denotes the result of execution and its client UI settings - refer to ProcessResponseWrapper.

Throws:
CreateFailedException
EngineCannotRunSynchronousException
EngineNotAuthorizedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
FaultReplyException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
ProcessException
ServiceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1.1 - FDML related exceptions removed

callWithUISettings

public ProcessResponseWrapper callWithUISettings(VTID vtid,
                                                 ATID atid,
                                                 ClientObjectWrapper inputMessage)
                                          throws CreateFailedException,
                                                 EngineCannotRunSynchronousException,
                                                 EngineNotAuthorizedException,
                                                 EngineProcessModelDoesNotExistException,
                                                 EngineProcessModelStoppedException,
                                                 FaultReplyException,
                                                 IdWrongFormatException,
                                                 ObjectDoesNotExistException,
                                                 ProcessException,
                                                 UnexpectedFailureException,
                                                 java.rmi.RemoteException,
                                                 javax.ejb.EJBException
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. An input message can be passed to specify initial values for the process instance.

This method returns only when the execution of the microflow finishes with the result of execution. If a fault occurs, an exception is thrown.

The process template must specify that derived process instances can run as a microflow and must return a reply.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

Specified by:
callWithUISettings in interface BusinessFlowManagerService
Parameters:
vtid - The object ID of the activity service template that is used to identify the starting service to be called.
atid - The object ID of the activity the activity service template belongs to.
inputMessage - The input message that specifies the initial values of the process instance. If input is not to be provided, null must be specified. The object wrapped by the ClientObjectWrapper must be serializable.

Returns:
ProcessResponseWrapper - The output message that denotes the result of execution and its client UI settings - refer to ProcessResponseWrapper.

Throws:
CreateFailedException
EngineCannotRunSynchronousException
EngineNotAuthorizedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
FaultReplyException
IdWrongFormatException
ObjectDoesNotExistException
ProcessException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1.1 - FDML related exceptions removed

initiate

public PIID initiate(java.lang.String processTemplateName,
                     ClientObjectWrapper inputMessage)
              throws CreateFailedException,
                     EngineAdministratorCannotBeResolvedException,
                     EngineCannotCreateWorkItemException,
                     EngineCannotInitializeVariableException,
                     EngineCannotOpenCompensationSphereException,
                     EngineCannotRunSynchronousException,
                     EngineNotAuthorizedException,
                     EngineParameterNullException,
                     EngineProcessCompensatedException,
                     EngineProcessModelDoesNotExistException,
                     EngineProcessModelStoppedException,
                     EngineWrongMessageTypeException,
                     FaultReplyException,
                     InvalidLengthException,
                     InvalidObjectNameException,
                     MissingPartsException,
                     ProcessException,
                     ProcessInstanceNotUniqueException,
                     ServiceNotUniqueException,
                     UnexpectedFailureException,
                     java.rmi.RemoteException,
                     javax.ejb.EJBException
Creates a process instance from the specified process template, passes the specified input message, and initiates processing of the process instance.

If the process is a long running process, then the name of the newly created process instance is derived from its object identifier. The starter of the process instance is set to the caller of this action and receives a work item for the process instance. Readers and process administrators are determined and receive work items for the process instance.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

Specified by:
initiate in interface BusinessFlowManagerService
Parameters:
processTemplateName - The name of the process template from which an instance is to be created. A process template name can be specified when the starting service is unique, that is, the process starts with a single receive or pick. The pick activity must specify a single onMessage so that the service to be called can be identified.
inputMessage - The input message that specifies the initial values of the process instance. If input is not to be provided, null must be specified. The object wrapped by the ClientObjectWrapper must be serializable.

Returns:
PIID - For long running processes, the ID of the process instance created else null.

Throws:
CreateFailedException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotRunSynchronousException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessCompensatedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineWrongMessageTypeException
FaultReplyException
InvalidLengthException
InvalidObjectNameException
MissingPartsException
ProcessException
ProcessInstanceNotUniqueException
ServiceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

initiate

public PIID initiate(java.lang.String processTemplateName,
                     java.lang.String processInstanceName,
                     ClientObjectWrapper inputMessage)
              throws CreateFailedException,
                     EngineAdministratorCannotBeResolvedException,
                     EngineCannotCreateWorkItemException,
                     EngineCannotInitializeVariableException,
                     EngineCannotOpenCompensationSphereException,
                     EngineCannotRunSynchronousException,
                     EngineNotAuthorizedException,
                     EngineParameterNullException,
                     EngineProcessCompensatedException,
                     EngineProcessInstanceNameNotUniqueException,
                     EngineProcessModelDoesNotExistException,
                     EngineProcessModelStoppedException,
                     EngineWrongMessageTypeException,
                     FaultReplyException,
                     InvalidLengthException,
                     InvalidObjectNameException,
                     MissingPartsException,
                     ProcessException,
                     ProcessInstanceNotUniqueException,
                     ServiceNotUniqueException,
                     UnexpectedFailureException,
                     java.rmi.RemoteException,
                     javax.ejb.EJBException
Creates a named process instance from the specified process template, passes the specified input message, and initiates processing of the process instance.

If the process is a long running process, then the starter of the process instance is set to the caller of this action and receives a work item for the process instance. Readers and process administrators are determined and receive work items for the process instance.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

Specified by:
initiate in interface BusinessFlowManagerService
Parameters:
processTemplateName - The name of the process template from which an instance is to be created. A process template name can be specified when the starting service is unique, that is, the process starts with a single receive or pick. The pick activity must specify a single onMessage so that the service to be called can be identified.
processInstanceName - The name of the process instance to be created; must not be greater than 220 bytes in UTF-8 format. The name must be unique. This parameter is ignored for microflows.
inputMessage - The input message that specifies the initial values of the process instance. If input is not to be provided, null must be specified. The object wrapped by the ClientObjectWrapper must be serializable.

Returns:
PIID - For long running processes, the ID of the process instance created else null.

Throws:
CreateFailedException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotRunSynchronousException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessCompensatedException
EngineProcessInstanceNameNotUniqueException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineWrongMessageTypeException
FaultReplyException
InvalidLengthException
InvalidObjectNameException
MissingPartsException
ProcessException
ProcessInstanceNotUniqueException
ServiceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

initiate

public PIID initiate(java.lang.String vtid,
                     java.lang.String atid,
                     java.lang.String processInstanceName,
                     ClientObjectWrapper inputMessage)
              throws CreateFailedException,
                     EngineNotAuthorizedException,
                     EngineParameterNullException,
                     EngineProcessInstanceNameNotUniqueException,
                     EngineProcessModelDoesNotExistException,
                     EngineProcessModelStoppedException,
                     IdWrongFormatException,
                     IdWrongTypeException,
                     InvalidObjectNameException,
                     MissingPartsException,
                     NoMacroFlowException,
                     ObjectDoesNotExistException,
                     ProcessException,
                     ProcessInstanceNotUniqueException,
                     UnexpectedFailureException,
                     java.rmi.RemoteException,
                     javax.ejb.EJBException
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.

The process must be a long running process. The starter of the process instance is set to the caller of this action and receives a work item for the process instance. Readers and process administrators are determined and receive work items for the process instance.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

Specified by:
initiate in interface BusinessFlowManagerService
Parameters:
vtid - The string representation of the activity service template object ID. This is used to identify the starting service.
atid - A string representation of the activity template ID. This is used to identify the activity the service belongs to.
processInstanceName - The name of the process instance to be created; must not be greater than 220 bytes in UTF-8 format. The name must be unique. This parameter is ignored for microflows.
inputMessage - The input message that specifies the initial values of the process instance. If input is not to be provided, null must be specified. The object wrapped by the ClientObjectWrapper must be serializable.

Returns:
PIID - The ID of the process instance created.

Throws:
CreateFailedException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessInstanceNameNotUniqueException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
IdWrongFormatException
IdWrongTypeException
InvalidObjectNameException
MissingPartsException
NoMacroFlowException
ObjectDoesNotExistException
ProcessException
ProcessInstanceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1.1

initiate

public PIID initiate(VTID vtid,
                     ATID atid,
                     java.lang.String processInstanceName,
                     ClientObjectWrapper inputMessage)
              throws CreateFailedException,
                     EngineNotAuthorizedException,
                     EngineParameterNullException,
                     EngineProcessInstanceNameNotUniqueException,
                     EngineProcessModelDoesNotExistException,
                     EngineProcessModelStoppedException,
                     IdWrongFormatException,
                     InvalidObjectNameException,
                     MissingPartsException,
                     NoMacroFlowException,
                     ObjectDoesNotExistException,
                     ProcessException,
                     ProcessInstanceNotUniqueException,
                     UnexpectedFailureException,
                     java.rmi.RemoteException,
                     javax.ejb.EJBException
Creates a named process instance identifying the starting service by its ID, passes the specified input message, and initiates processing of the process instance.

The process must be a long running process. The starter of the process instance is set to the caller of this action and receives a work item for the process instance. Readers and process administrators are determined and receive work items for the process instance.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

Specified by:
initiate in interface BusinessFlowManagerService
Parameters:
vtid - The object ID of the activity service template. This is used to identify the starting service.
atid - The object ID of the activity the activity service template belongs to.
processInstanceName - The name of the process instance to be created; must not be greater than 220 bytes in UTF-8 format. The name must be unique. This parameter is ignored for microflows.
inputMessage - The input message that specifies the initial values of the process instance. If input is not to be provided, null must be specified. The object wrapped by the ClientObjectWrapper must be serializable.

Returns:
PIID - The ID of the process instance created.

Throws:
CreateFailedException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessInstanceNameNotUniqueException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
IdWrongFormatException
InvalidObjectNameException
MissingPartsException
NoMacroFlowException
ObjectDoesNotExistException
ProcessException
ProcessInstanceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1.1

forceTerminate

public void forceTerminate(java.lang.String identifier)
                    throws EngineNotAuthorizedException,
                           EngineWrongKindException,
                           EngineWrongStateException,
                           IdWrongTypeException,
                           ObjectDoesNotExistException,
                           UnexpectedFailureException,
                           java.rmi.RemoteException,
                           javax.ejb.EJBException
Terminates the specified top-level process instance, its subprocesses, and its running, claimed, or waiting activities using a string representation of the process instance ID or the process instance name. For example, you can use these capabilities to remove failed process instances that are still in a running state. This example might result from an invoked application that failed and that did not return to a dormant state.

Use the process termination capabilities as a last resort only. The process instance is immediately terminated without waiting for outstanding activities to complete. Process instances that are terminated are not compensated.

The process instance must be in the running, suspended, or failing execution state. Only an administrator of the process instance can terminate the process instance.

The process instance is put into the terminated execution state.

If the "auto delete" option is not set or set to 'true', the process instance is automatically deleted.

Specified by:
forceTerminate in interface BusinessFlowManagerService
Parameters:
identifier - The string representation of the process instance object ID or the name of the process instance. This is used to identify the process instance that is to be terminated.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

forceTerminate

public void forceTerminate(PIID piid)
                    throws EngineNotAuthorizedException,
                           EngineWrongKindException,
                           EngineWrongStateException,
                           IdWrongFormatException,
                           ObjectDoesNotExistException,
                           UnexpectedFailureException,
                           java.rmi.RemoteException,
                           javax.ejb.EJBException
Terminates the specified top-level process instance, its subprocesses, and its running, claimed, or waiting activities using the process instance ID. For example, you can use these capabilities to remove failed process instances that are still in a running state. This example might result from an invoked application that failed and that did not return to a dormant state.

Use the process termination capabilities as a last resort only. The process instance is immediately terminated without waiting for outstanding activities to complete. Process instances that are terminated are not compensated.

The process instance must be in the running, suspended, or failing execution state. Only an administrator of the process instance can terminate the process instance.

The process instance is put into the terminated execution state.

If the "auto delete" option is not set or set to 'true', the process instance is automatically deleted.

Specified by:
forceTerminate in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance to be terminated.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

forceTerminate

public void forceTerminate(java.lang.String identifier,
                           int invokeCompensation)
                    throws EngineNotAuthorizedException,
                           EngineWrongKindException,
                           EngineWrongStateException,
                           IdWrongTypeException,
                           InvalidParameterValueException,
                           ObjectDoesNotExistException,
                           UnexpectedFailureException,
                           java.rmi.RemoteException,
                           javax.ejb.EJBException
Terminates the specified top-level process instance, its subprocesses, its running, claimed, or waiting activities using a string representation of the process instance ID or the process instance name. For example, you can use these capabilities to remove failed process instances that are still in a running state. This example might result from an invoked application that failed and that did not return to a dormant state.

Use the process termination capabilities as a last resort only. The process instance is immediately terminated without waiting for outstanding activities to complete.

Depending on the invokeCompensation indicator, the process instance is compensated or not. If compensation is to be ignored, the process instance is immediately terminated. If compensation is to be invoked, the process instance is compensated before it is terminated provided that compensation is defined at all. Otherwise, the process instance is terminated without compensation.

The process instance must be in the running, suspended, or failing execution state. Only an administrator of the process instance can terminate the process instance.

The process instance is put into the terminated execution state.

If the "auto delete" option is not set or set to 'true', the process instance is automatically deleted.

Specified by:
forceTerminate in interface BusinessFlowManagerService
Parameters:
identifier - The string representation of the process instance object ID or the name of the process instance. This is used to identify the process instance that is to be terminated.
invokeCompensation - An indicator whether compensation is to be executed or not - refer to CompensationBehaviour for valid values. If compensation is to be ignored, compensation is not invoked even if defined. If compensation is to be invoked, compensation is executed if defined.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongTypeException
InvalidParameterValueException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

forceTerminate

public void forceTerminate(PIID piid,
                           int invokeCompensation)
                    throws EngineNotAuthorizedException,
                           EngineWrongKindException,
                           EngineWrongStateException,
                           IdWrongFormatException,
                           InvalidParameterValueException,
                           ObjectDoesNotExistException,
                           UnexpectedFailureException,
                           java.rmi.RemoteException,
                           javax.ejb.EJBException
Terminates the specified top-level process instance, its subprocesses, its running, claimed, or waiting activities using the process instance ID. For example, you can use these capabilities to remove failed process instances that are still in a running state. This example might result from an invoked application that failed and that did not return to a dormant state.

Use the process termination capabilities as a last resort only. The process instance is immediately terminated without waiting for outstanding activities to complete. Process instances that are terminated are not compensated.

Depending on the invokeCompensation flag, the process instance is compensated or not. If compensation is to be ignored, the process instance is immediately terminated. If compensation is to be invoked, the process instance is compensated before it is terminated provided that compensation is defined at all. Otherwise, the process instance is terminated without compensation.

The process instance must be in the running, suspended, or failing execution state. Only an administrator of the process instance can terminate the process instance.

The process instance is put into the terminated execution state.

If the "auto delete" option is not set or set to 'true', the process instance is automatically deleted.

Specified by:
forceTerminate in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance to be terminated.
invokeCompensation - An indicator whether compensation is to be executed or not - refer to CompensationBehaviour for valid values. If compensation is to be ignored, compensation is not invoked even if defined. If compensation is to be invoked, compensation is executed if defined.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidParameterValueException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

delete

public void delete(java.lang.String piid)
            throws EngineNotAuthorizedException,
                   EngineWrongKindException,
                   EngineWrongStateException,
                   IdWrongFormatException,
                   IdWrongTypeException,
                   UnexpectedFailureException,
                   java.rmi.RemoteException,
                   javax.ejb.EJBException
Deletes the specified top-level process instance and its subprocesses using a string representation of the process instance ID.

The process instance must be in the finished, terminated, compensated, or failed execution state. The caller must be an administrator of the process instance.

Specified by:
delete in interface BusinessFlowManagerService
Parameters:
piid - A string representation of the process instance object ID that is used to identify the process instance to be deleted.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

delete

public void delete(PIID piid)
            throws EngineNotAuthorizedException,
                   EngineWrongKindException,
                   EngineWrongStateException,
                   IdWrongFormatException,
                   UnexpectedFailureException,
                   java.rmi.RemoteException,
                   javax.ejb.EJBException
Deletes the specified top-level process instance and its subprocesses using the process instance ID.

The process instance must be in the finished, terminated, compensated, or failed execution state. The caller must be an administrator of the process instance.

Specified by:
delete in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance to be deleted.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

restart

public void restart(PIID piid)
             throws EngineNotAuthorizedException,
                    EngineProcessModelStoppedException,
                    EngineWrongKindException,
                    EngineWrongStateException,
                    IdWrongFormatException,
                    ObjectDoesNotExistException,
                    UnexpectedFailureException,
                    ProcessException,
                    java.rmi.RemoteException,
                    javax.ejb.EJBException
Restarts the specified top-level process instance and its subprocesses using the process instance ID.

The process instance must be in the finished, terminated, compensated, or failed execution state. A process instance may only be restarted, if the corresponding schema version of the process template is at least 6.0. The caller must be an administrator of the process instance.

Specified by:
restart in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance to be restarted.

Throws:
EngineNotAuthorizedException
EngineProcessModelStoppedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
ProcessException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

restart

public void restart(java.lang.String piid)
             throws EngineNotAuthorizedException,
                    EngineProcessModelStoppedException,
                    EngineWrongKindException,
                    EngineWrongStateException,
                    IdWrongFormatException,
                    IdWrongTypeException,
                    ObjectDoesNotExistException,
                    UnexpectedFailureException,
                    ProcessException,
                    java.rmi.RemoteException,
                    javax.ejb.EJBException
Restarts the specified top-level process instance and its subprocesses using the process instance ID.

The process instance must be in the finished, terminated, compensated, or failed execution state. A process instance may only be restarted, if the corresponding schema version of the process template is at least 6.0. The caller must be an administrator of the process instance.

Specified by:
restart in interface BusinessFlowManagerService
Parameters:
piid - A string representation of the process instance object ID that is used to identify the process instance to be restarted.

Throws:
EngineNotAuthorizedException
EngineProcessModelStoppedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
ProcessException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

resume

public void resume(PIID piid)
            throws EngineNotAuthorizedException,
                   EngineWrongKindException,
                   EngineWrongStateException,
                   IdWrongFormatException,
                   ObjectDoesNotExistException,
                   UnexpectedFailureException,
                   java.rmi.RemoteException,
                   javax.ejb.EJBException
Resumes the specified top-level process instance and its subprocesses using the process instance ID.

The process instance must be in the suspended execution state. The caller must be an administrator of the process instance.

Specified by:
resume in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance to be resumed.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

resume

public void resume(java.lang.String piid)
            throws EngineNotAuthorizedException,
                   EngineWrongKindException,
                   EngineWrongStateException,
                   IdWrongFormatException,
                   IdWrongTypeException,
                   ObjectDoesNotExistException,
                   UnexpectedFailureException,
                   java.rmi.RemoteException,
                   javax.ejb.EJBException
Resumes the specified top-level process instance and its subprocesses using a string representation of the process instance ID.

The process instance must be in the suspended execution state. The caller must be an administrator of the process instance.

Specified by:
resume in interface BusinessFlowManagerService
Parameters:
piid - A string representation of the process instance object ID that is used to identify the process instance to be resumed.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

suspend

public void suspend(PIID piid)
             throws EngineNotAuthorizedException,
                    EngineWrongKindException,
                    EngineWrongStateException,
                    IdWrongFormatException,
                    ObjectDoesNotExistException,
                    UnexpectedFailureException,
                    java.rmi.RemoteException,
                    javax.ejb.EJBException
Suspends the specified top-level process instance and its subprocesses using the process instance ID.

The process instance must be in the running or failing execution state. Subprocesses are suspended if they are in state running, failing or terminating. The caller must be an administrator of the process instance.

Specified by:
suspend in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance to be suspended.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

suspend

public void suspend(java.lang.String piid)
             throws EngineNotAuthorizedException,
                    EngineWrongKindException,
                    EngineWrongStateException,
                    IdWrongFormatException,
                    IdWrongTypeException,
                    ObjectDoesNotExistException,
                    UnexpectedFailureException,
                    java.rmi.RemoteException,
                    javax.ejb.EJBException
Suspends the specified top-level process instance and its subprocesses using a string representation of the process instance ID.

The process instance must be in the running or failing execution state. The caller must be an administrator of the process instance.

Specified by:
suspend in interface BusinessFlowManagerService
Parameters:
piid - A string representation of the process instance object ID that is used to identify the process instance to be suspended.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

createWorkItem

public void createWorkItem(java.lang.String identifier,
                           int assignmentReason,
                           java.lang.String userID)
                    throws EngineEverybodyWorkItemException,
                           EngineNotAuthorizedException,
                           EngineParameterNullException,
                           EngineProcessReaderWorkItemException,
                           EngineWrongKindException,
                           EngineWrongStateException,
                           HumanTaskManagerException,
                           IdWrongFormatException,
                           IdWrongTypeException,
                           InvalidLengthException,
                           ObjectDoesNotExistException,
                           UnexpectedFailureException,
                           WorkItemManagerException,
                           java.rmi.RemoteException,
                           javax.ejb.EJBException
Creates a work item for processes or activities using a string representation of either the process or activity instance ID. The work item is created with the specified assignment reason for the specified process or activity instance and the specified user.

Work items with assignment reasons "starter" or "owner" cannot be explicitly created. Work items with assignment reasons "administrator" can only be created on the process instance.

Work items with assignment reasons "administrator" or "reader" for the process instance are automatically propagated to all enclosed activity instances.

The process instance must be in the running, failing, or terminating execution state. When a work item for an activity instance is to be created, the activity instance must be in the claimed, waiting, ready, or stopped execution state. The activity must be an invoke, script, or staff activity.

The caller must be an administrator of the process instance.

Specified by:
createWorkItem in interface BusinessFlowManagerService
Parameters:
identifier - A string representation of the process or activity instance ID that is used to identify the object the new work item should belong to.
assignmentReason - The reason why the work item is assigned - refer to WorkItemData or getAssignmentReason for possible values.
userID - The user the work item should belong to. It is not checked whether the user exists.

Throws:
EngineEverybodyWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessReaderWorkItemException
EngineWrongKindException
EngineWrongStateException
HumanTaskManagerException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

createWorkItem

public void createWorkItem(PIID piid,
                           int assignmentReason,
                           java.lang.String userID)
                    throws EngineEverybodyWorkItemException,
                           EngineNotAuthorizedException,
                           EngineParameterNullException,
                           EngineProcessReaderWorkItemException,
                           EngineWrongKindException,
                           EngineWrongStateException,
                           HumanTaskManagerException,
                           IdWrongFormatException,
                           InvalidLengthException,
                           ObjectDoesNotExistException,
                           UnexpectedFailureException,
                           WorkItemManagerException,
                           java.rmi.RemoteException,
                           javax.ejb.EJBException
Creates a work item for processes with the specified assignment reason for the specified process instance and user.

A work item with an assignment reason "starter" cannot be explicitly created. Work items with assignment reasons "administrator" or "reader" are automatically propagated to all enclosed activity instances.

The process instance must be in the running, failing, or terminating execution state. The caller must be an administrator of the process instance.

Specified by:
createWorkItem in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance the new work item should belong to.
assignmentReason - The reason why the work item is assigned - refer to WorkItemData or getAssignmentReason for possible values.
userID - The user the work item should belong to. It is not checked whether the user exists.

Throws:
EngineEverybodyWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessReaderWorkItemException
EngineWrongKindException
EngineWrongStateException
HumanTaskManagerException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

createWorkItem

public void createWorkItem(AIID aiid,
                           int assignmentReason,
                           java.lang.String userID)
                    throws EngineEverybodyWorkItemException,
                           EngineNotAuthorizedException,
                           EngineParameterNullException,
                           EngineProcessReaderWorkItemException,
                           EngineWrongKindException,
                           EngineWrongStateException,
                           HumanTaskManagerException,
                           IdWrongFormatException,
                           InvalidLengthException,
                           ObjectDoesNotExistException,
                           UnexpectedFailureException,
                           WorkItemManagerException,
                           java.rmi.RemoteException,
                           javax.ejb.EJBException
Creates a work item for activities with the specified assignment reason for the specified activity instance and user.

A work item with an assignment reason "owner" cannot be explicitly created. Work items with assignment reasons "administrator" can only be created on the process instance.

The activity instance must be in the claimed, waiting, ready, or stopped execution state. The associated process instance must be in the running, failing, or terminating execution state. The activity must be an invoke, script, or staff activity.

The caller must be an administrator of the associated process instance.

Specified by:
createWorkItem in interface BusinessFlowManagerService
Parameters:
aiid - The object ID of the activity instance the new work item should belong to.
assignmentReason - The reason why the work item is assigned - refer to WorkItemData or getAssignmentReason for possible values.
userID - The user the work item should belong to. It is not checked whether the user exists.

Throws:
EngineEverybodyWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessReaderWorkItemException
EngineWrongKindException
EngineWrongStateException
HumanTaskManagerException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

deleteWorkItem

public void deleteWorkItem(java.lang.String identifier,
                           int assignmentReason,
                           java.lang.String userID)
                    throws EngineEverybodyWorkItemException,
                           EngineLastAdminWorkItemException,
                           EngineNotAuthorizedException,
                           EngineParameterNullException,
                           EngineProcessReaderWorkItemException,
                           EngineWrongKindException,
                           EngineWrongStateException,
                           HumanTaskManagerException,
                           IdWrongFormatException,
                           IdWrongTypeException,
                           InvalidLengthException,
                           ObjectDoesNotExistException,
                           UnexpectedFailureException,
                           WorkItemManagerException,
                           java.rmi.RemoteException,
                           javax.ejb.EJBException
Deletes the specified work item using a string representation of either the process or activity instance ID.

Following restrictions apply:

The process instance must be in the running, failing, or terminating execution state. When a work item for an activity instance is to be deleted, the activity instance must be in the claimed, waiting, ready, or stopped execution state. The activity must be an invoke, script, or staff activity.

The caller must be an administrator of the process instance.

Specified by:
deleteWorkItem in interface BusinessFlowManagerService
Parameters:
identifier - A string representation of the process or activity instance ID that is used to identify the object the work item belongs to.
assignmentReason - The reason why the work item has been assigned - refer to getAssignmentReason for valid values.
userID - The user the work item belongs to.

Throws:
EngineEverybodyWorkItemException
EngineLastAdminWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessReaderWorkItemException
EngineWrongKindException
EngineWrongStateException
HumanTaskManagerException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

deleteWorkItem

public void deleteWorkItem(PIID piid,
                           int assignmentReason,
                           java.lang.String userID)
                    throws EngineEverybodyWorkItemException,
                           EngineLastAdminWorkItemException,
                           EngineNotAuthorizedException,
                           EngineParameterNullException,
                           EngineProcessReaderWorkItemException,
                           EngineWrongKindException,
                           EngineWrongStateException,
                           HumanTaskManagerException,
                           IdWrongFormatException,
                           InvalidLengthException,
                           ObjectDoesNotExistException,
                           UnexpectedFailureException,
                           WorkItemManagerException,
                           java.rmi.RemoteException,
                           javax.ejb.EJBException
Deletes the specified work item for the specified process instance.

Following restrictions apply:

The deletion of a process reader or administrator work item is automatically propagated to all enclosed activities.

The process instance must be in the running, failing, or terminating execution state. The caller must be an administrator of the process instance.

Specified by:
deleteWorkItem in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance the work item belongs to.
assignmentReason - The reason why the work item has been assigned - refer to getAssignmentReason for valid values.
userID - The user the work item belongs to.

Throws:
EngineEverybodyWorkItemException
EngineLastAdminWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessReaderWorkItemException
EngineWrongKindException
EngineWrongStateException
HumanTaskManagerException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

deleteWorkItem

public void deleteWorkItem(AIID aiid,
                           int assignmentReason,
                           java.lang.String userID)
                    throws EngineEverybodyWorkItemException,
                           EngineLastAdminWorkItemException,
                           EngineNotAuthorizedException,
                           EngineParameterNullException,
                           EngineProcessReaderWorkItemException,
                           EngineWrongKindException,
                           EngineWrongStateException,
                           HumanTaskManagerException,
                           IdWrongFormatException,
                           InvalidLengthException,
                           ObjectDoesNotExistException,
                           UnexpectedFailureException,
                           WorkItemManagerException,
                           java.rmi.RemoteException,
                           javax.ejb.EJBException
Deletes the specified work item for the specified activity instance.

Following restrictions apply:

The caller must be an administrator of the process instance.

Specified by:
deleteWorkItem in interface BusinessFlowManagerService
Parameters:
aiid - The object ID of the activity instance the work item belongs to.
assignmentReason - The reason why the work item has been assigned - refer to getAssignmentReason for valid values.
userID - The user the work item belongs to.

Throws:
EngineEverybodyWorkItemException
EngineLastAdminWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessReaderWorkItemException
EngineWrongKindException
EngineWrongStateException
HumanTaskManagerException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

transferWorkItem

public void transferWorkItem(java.lang.String identifier,
                             int assignmentReason,
                             java.lang.String fromUserID,
                             java.lang.String toUserID)
                      throws EngineEverybodyWorkItemException,
                             EngineNotAuthorizedException,
                             EngineParameterNullException,
                             EngineProcessReaderWorkItemException,
                             EngineWrongKindException,
                             EngineWrongStateException,
                             HumanTaskManagerException,
                             IdWrongFormatException,
                             IdWrongTypeException,
                             InvalidLengthException,
                             ObjectDoesNotExistException,
                             UnexpectedFailureException,
                             WorkItemManagerException,
                             java.rmi.RemoteException,
                             javax.ejb.EJBException
Transfers the specified work item for a process or activity instance to the specified user, using a string representation of either the process or activity instance ID.

Following restrictions apply:

When work items with assignment reasons "administrator" or "reader" for the process instance are transferred, the transfer is automatically propagated to all enclosed activity instances.

The process instance must be in the running, failing, or terminating execution state. When a work item for an activity instance is to be transferred, the activity instance must be in the claimed, waiting, ready, or stopped execution state. The activity must be an invoke, script, or staff activity.

The caller must own the work item with an assignment reason "owner" or be an administrator of the associated process instance.

Specified by:
transferWorkItem in interface BusinessFlowManagerService
Parameters:
identifier - A string representation of the process or activity instance ID that is used to identify the work item to be transferred.
assignmentReason - The reason why the work item has been assigned - refer to getAssignmentReason for valid values.
fromUserID - The user the work item belongs to.
toUserID - The user the work item is to be transferred to. It is not checked whether the user exists.

Throws:
EngineEverybodyWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessReaderWorkItemException
EngineWrongKindException
EngineWrongStateException
HumanTaskManagerException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

transferWorkItem

public void transferWorkItem(PIID piid,
                             int assignmentReason,
                             java.lang.String fromUserID,
                             java.lang.String toUserID)
                      throws EngineEverybodyWorkItemException,
                             EngineNotAuthorizedException,
                             EngineParameterNullException,
                             EngineProcessReaderWorkItemException,
                             EngineWrongKindException,
                             EngineWrongStateException,
                             HumanTaskManagerException,
                             IdWrongFormatException,
                             InvalidLengthException,
                             ObjectDoesNotExistException,
                             UnexpectedFailureException,
                             WorkItemManagerException,
                             java.rmi.RemoteException,
                             javax.ejb.EJBException
Transfers a work item for the specified process instance to the specified user using the process instance ID.

A work item with an assignment reason "starter" cannot be transferred.

When work items with assignment reasons "administrator" or "reader" are transferred, the transfer is automatically propagated to all enclosed activity instances.

The process instance must be in the running, failing, or terminating execution state. The caller must be an administrator of the process instance.

Specified by:
transferWorkItem in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance the work item belongs to.
assignmentReason - The reason why the work item has been assigned - refer to getAssignmentReason for valid values.
fromUserID - The user the work item belongs to.
toUserID - The user the work item is to be transferred to. It is not checked whether the user exists.

Throws:
EngineEverybodyWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessReaderWorkItemException
EngineWrongKindException
EngineWrongStateException
HumanTaskManagerException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

transferWorkItem

public void transferWorkItem(AIID aiid,
                             int assignmentReason,
                             java.lang.String fromUserID,
                             java.lang.String toUserID)
                      throws EngineEverybodyWorkItemException,
                             EngineNotAuthorizedException,
                             EngineParameterNullException,
                             EngineProcessReaderWorkItemException,
                             EngineWrongKindException,
                             EngineWrongStateException,
                             HumanTaskManagerException,
                             IdWrongFormatException,
                             InvalidLengthException,
                             ObjectDoesNotExistException,
                             UnexpectedFailureException,
                             WorkItemManagerException,
                             java.rmi.RemoteException,
                             javax.ejb.EJBException
Transfers a work item for the specified activity instance to the specified user using the activity instance ID.

Following restrictions apply:

The activity instance must be in the claimed, waiting, ready, or stopped execution state. The associated process instance must be in the running, failing, or terminating execution state. The activity must be an invoke, script, or staff activity.

The caller must own the work item with an assignment reason "owner" or be an administrator of the associated process instance.

Specified by:
transferWorkItem in interface BusinessFlowManagerService
Parameters:
aiid - The object ID of the activity instance the work item belongs to.
assignmentReason - The reason why the work item has been assigned - refer to getAssignmentReason for valid values.
fromUserID - The user the work item belongs to.
toUserID - The user the work item is to be transferred to. It is not checked whether the user exists.

Throws:
EngineEverybodyWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessReaderWorkItemException
EngineWrongKindException
EngineWrongStateException
HumanTaskManagerException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

newWorkList

public 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)
                 throws EngineNotAuthorizedException,
                        InvalidLengthException,
                        UnexpectedFailureException,
                        java.rmi.RemoteException,
                        javax.ejb.EJBException
Deprecated. WorkList has been renamed to StoredQuery. Use createStoredQuery(.

Creates a worklist and persistently stores it in the database. Only a business process administrator can create a worklist.

A worklist represents a set of selected object properties. The number of tuples in the set can be restricted by a filter or threshold. Additionally, sort criteria can be defined that are applied on the server.

The domain of the query, that is, the SQL from-clause, is determined automatically. In principle, all properties of objects are selectable for which you own a work item, that is, which can be transitively reached via a user's work item. As a rule of thumb, all objects except process templates can be reached via work items.

The business process administrator has special rights and can access all objects, included process templates, that is, the business process administrator is the only user who can use properties of the PROCESS_TEMPLATE view only. All other users must specify a non process template property in the select- or where-clause.

Although worklist definitions are stored persistently, object properties contained in the worklist are assembled dynamically when they are queried. All worklists are publicly accessible - refer to executeWorkList for the execution of worklists.

When a worklist definition needs to be updated, it must be deleted and recreated - refer to deleteWorkList for the deletion of worklists.

Specified by:
newWorkList in interface BusinessFlowManagerService
Parameters:
workListName - The name of the worklist to be created; must not be greater than 64 bytes in UTF-8 format. The name must be unique.

selectClause - Describes the query result returned when the worklist is executed. It declares a list of names that identify the object properties (columns of the result) to be returned. Its syntax is an SQL select-clause. Aggregation functions like AVG(), SUM(), MIN(), and MAX() are, however, not supported. Each part of the select-clause separated by a comma must specify a property from the published views.

To select properties of name-value pairs like custom properties, add a one-digit suffix (0-9) to the view name. For example, "ACTIVITY_ATTRIBUTE1.VALUE, ACTIVITY_ATTRIBUTE2.VALUE".

To count the number of potentially qualifying tuples, use the COUNT keyword. For example, to count the number of activity instance IDs that satisfy the where-clause, specify a select-clause such as "COUNT(DISTINCT ACTIVITY.AIID)". If you use the more generic "COUNT(*)", then you must specify a where-clause so that the tuples to be counted can be determined. For example, to count all activities, specify a where-clause such as "ACTIVITY.AIID=ACTIVITY.AIID" that always evaluates to true.

The QueryResultSet contains columns in the same order as specified in the selectClause. If tuples are to be counted, an int value is returned (row 1, column 1).

whereClause - Specifies the search condition that is applied when the worklist is executed. Its syntax is an SQL where-clause. The following rules apply:
  • Specify object ID constants as ID('string-rep-of-oid').
  • Specify timestamp constants as TS('yyyy-mm-ddThh:mm:ss') or as CURRENT_DATE for comparisons with the current date.
    The date and time parts of a TS definition are optional; either the date or the time must be specified. If no date part of a TS definition is specified, the current date is taken. Optional time values that are not specified are set to zero. The timestamp is 24 hours based. For example, TS('16:04') is the same as TS('2002-12-24T16:04:00') provided that the current date is December 24th, 2002.
    If a date part of a TS definition is specified, the year must consist of 4 letters; the month and day specifications are optional. Missing month and day specifications are set to 01. For example, specifying TS('2003') is the same as specifying TS('2003-01-01T00:00:00').
  • Specify binary constants as BIN('UTF-8 string').
  • Use constants instead of integer enumerations. For example, instead of specifying an activity state expression "ACTIVITY.STATE=2" , specify "ACTIVITY.STATE=ACTIVITY.STATE.STATE_READY".
  • Duplicate apostrophes (') in comparising values. For example, "ACTIVITY.NAME='d''automatisation'".
  • To specify a where clause that refers to properties of name-value pairs, like custom properties, add a one-digit suffix (0-9) to the view name.
    For example, to have only tuples returned where an activity custom property "prop1" has the value "v1" or where an activity custom property "prop2" has the value v2", the where clause can look like "ACTIVITY_ATTRIBUTE1.NAME='prop1' AND ACTIVITY_ATTRIBUTE1.VALUE='v1' OR ACTIVITY_ATTRIBUTE2.NAME='prop2' AND ACTIVITY_ATTRIBUTE2.VALUE = 'v2'". For performance reasons, you should not use more than one "OR" construct; use "IN" instead.
    For example, to retrieve the values of custom properties "prop1" and "prop2" of all activity instances, the select clause can look like "DISTINCT ACTIVITY.AIID, ACTIVITY_ATTRIBUTE1.VALUE, ACTIVITY_ATTRIBUTE2.VALUE" and the where-clause "ACTIVITY_ATTRIBUTE1.NAME = 'prop1' AND ACTIVITY_ATTRIBUTE2.NAME = 'prop2'".

If a filter is not to be applied, null must be specified.

A whereClause must not be greater than 2048 bytes in UTF-8 format.

orderByClause - Orders the result of the worklist execution by the values of the columns you identify. Its syntax is an SQL order-by-clause. Each part of the order-by-clause separated by a comma must specify a property from the published views.

If you identify more that one property, the worklist execution result is ordered by the values of the first property you identify, then by the values of the second property, and so on.

If sort criteria are not to be applied, null must be specified.

An orderByClause must not be greater than 254 bytes in UTF-8 format.

Note that sort criteria are applied on the server, that is, the locale of the server is used for sorting.

threshold - The maximum number of worklist execution result tuples to be returned from the server to the client. If a threshold is not to be applied, null must be specified.
timeZone - Specifies the time zone of the timestamp constants in the whereClause. If a timezone is not specified, UTC is assumed.

Throws:
EngineNotAuthorizedException
InvalidLengthException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0

getWorkListNames

public java.lang.String[] getWorkListNames()
                                    throws WorkItemManagerException,
                                           UnexpectedFailureException,
                                           java.rmi.RemoteException,
                                           javax.ejb.EJBException
Deprecated. WorkList has been renamed to StoredQuery. Use getStoredQueryNames(.

Retrieves the names of worklists persistently stored in the database. Refer to newWorkList for the creation of worklists.

Specified by:
getWorkListNames in interface BusinessFlowManagerService
Returns:
String[] - An array of worklist names. If there are no worklists defined, an empty array is returned.

Throws:
WorkItemManagerException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0

deleteWorkList

public void deleteWorkList(java.lang.String workListName)
                    throws EngineNotAuthorizedException,
                           UnexpectedFailureException,
                           java.rmi.RemoteException,
                           javax.ejb.EJBException
Deprecated. WorkList has been renamed to StoredQuery. Use deleteStoredQuery(.

Deletes the specified worklist. Only a business process administrator can delete a worklist. No error is signalled when the specified worklist does no longer exist.

Refer to newWorkList for the creation of worklists.

Specified by:
deleteWorkList in interface BusinessFlowManagerService
Parameters:
workListName - The name of the worklist to be deleted - refer to getWorkListNames for the retrieval of existing worklist names.

Throws:
EngineNotAuthorizedException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0

getWorkList

public WorkListData getWorkList(java.lang.String workListName)
                         throws UnexpectedFailureException,
                                java.rmi.RemoteException,
                                javax.ejb.EJBException
Deprecated. WorkList has been renamed to StoredQuery. Use getStoredQuery(.

Retrieves the specified worklist definition.

Specified by:
getWorkList in interface BusinessFlowManagerService
Parameters:
workListName - The name of the worklist to be retrieved - refer to getWorkListNames for the retrieval of existing worklist names.

Returns:
WorkListData - The definition of the worklist retrieved - refer to WorkListData to view the worklist definition. If the specified worklist is not found, a null object is returned.

Throws:
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0

executeWorkList

public QueryResultSet executeWorkList(java.lang.String workListName)
                               throws IdWrongFormatException,
                                      ObjectDoesNotExistException,
                                      QueryInvalidOperandException,
                                      QueryInvalidTimestampException,
                                      QueryUndefinedParameterException,
                                      QueryUnknownColumnException,
                                      QueryUnknownOperatorException,
                                      QueryUnknownTableException,
                                      UnexpectedFailureException,
                                      java.rmi.RemoteException,
                                      javax.ejb.EJBException
Deprecated. WorkList has been renamed to StoredQuery. Use query().

Executes the query defined by the worklist and returns the qualifying object properties. Only properties of objects are returned for which the logged-on user has a work item. Note that the business process administrator has special rights and can access all objects.

Refer to newWorkList for the creation of worklists.

Specified by:
executeWorkList in interface BusinessFlowManagerService
Parameters:
workListName - The name of the worklist to be executed - refer to getWorkListNames for the retrieval of existing worklist names.

Returns:
QueryResultSet - The qualifying object properties. If qualifying objects are not found, an empty query result set is returned. Refer to QueryResultSet for information on how to analyze the query result set.

Throws:
IdWrongFormatException
ObjectDoesNotExistException
QueryInvalidOperandException
QueryInvalidTimestampException
QueryUndefinedParameterException
QueryUnknownColumnException
QueryUnknownOperatorException
QueryUnknownTableException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0

createStoredQuery

public 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)
                       throws EngineNotAuthorizedException,
                              EngineParameterNullException,
                              InvalidLengthException,
                              StoredQueryNameNotUniqueException,
                              UnexpectedFailureException,
                              java.rmi.RemoteException,
                              javax.ejb.EJBException
Creates a query definition and persistently stores it in the database for general usage. Only a business process administrator can create a stored query.

A stored query represents a set of selected object properties. The number of tuples in the set can be restricted by a filter or threshold. When executing the stored query, that set can additionally be restricted by specifying a starting tuple parameter.

Besides defining filtering criteria, sort criteria can be defined that are applied on the server. This means that the locale of the server is used for sorting.

Specify the parameters of the query definition, the select-, where-, and order-by-clause, using SQL based on the published views. Execution of the query can thus be shifted to SQL and becomes portable and optimizable.

The domain of the query, that is, the SQL from-clause, is determined automatically. All properties of objects are returned for which you own a work item, that is, which can be transitively reached via your work items.

Note that a business process administrator or a system monitor has special rights. They can retrieve all properties of objects for which there is some user's work item. Above that, these persons are the only users who can use properties of the PROCESS_TEMPLATE view only. All other users must specify at least one non process template property in the select- or where-clause.

Although stored query definitions are stored persistently, object properties contained in the stored query are assembled dynamically when they are queried. All stored queries are publicly accessible - refer to query for the execution of stored queries.

When a stored query definition needs to be updated, it must be deleted and recreated - refer to deleteStoredQuery for the deletion of stored queries.

Specified by:
createStoredQuery in interface BusinessFlowManagerService
Parameters:
storedQueryName - The name of the stored query to be created; must not be greater than 64 bytes in UTF-8 format. The name must be unique.
selectClause - Describes the query result produced that is returned when the stored query is executed. Its syntax is an SQL select-clause.

It either declares a list of names that identify the object properties (columns of the result) to be returned or it specifies the COUNT keyword. Aggregation functions like AVG(), SUM(), MIN(), and MAX() are not supported.

Each part of the select-clause separated by a comma must specify a property from the published views - see the InfoCenter for details.

To select properties of name-value pairs like custom properties, add a one-digit suffix (0-9) to the view name. For example, "ACTIVITY_ATTRIBUTE1.VALUE, ACTIVITY_ATTRIBUTE2.VALUE".

To count the number of potentially qualifying tuples, use the COUNT keyword. For example, to count the number of activity instance IDs that satisfy the where-clause, specify a select-clause such as "COUNT(DISTINCT ACTIVITY.AIID)". If you use the more generic "COUNT(*)", then you must specify a where-clause so that the tuples to be counted can be determined. For example, to count all activities, specify a where-clause such as "ACTIVITY.AIID=ACTIVITY.AIID" that always evaluates to true.

A selectClause must not be greater than 512 bytes in UTF-8 format.

The QueryResultSet contains columns in the same order as specified in the selectClause. If tuples are to be counted, an int value is returned (row 1, column 1).

whereClause - Specifies the search condition that is applied when the stored query is executed. Its syntax is an SQL where-clause. The following rules apply:
  • Specify object ID constants as ID('string-rep-of-oid').
  • Specify timestamp constants as TS('yyyy-mm-ddThh:mm:ss') or as CURRENT_DATE for comparisons with the current date.
    The date and time parts of a TS definition are optional; either the date or the time must be specified. If no date part of a TS definition is specified, the current date is taken. Optional time values that are not specified are set to zero. The timestamp is 24 hours based. For example, TS('16:04') is the same as TS('2002-12-24T16:04:00') provided that the current date is December 24th, 2002.
    If a date part of a TS definition is specified, the year must consist of 4 letters; the month and day specifications are optional. Missing month and day specifications are set to 01. For example, specifying TS('2003') is the same as specifying TS('2003-01-01T00:00:00').
  • Specify binary constants as BIN('UTF-8 string').
  • Use constants instead of integer enumerations. For example, instead of specifying an activity state expression "ACTIVITY.STATE=2" , specify "ACTIVITY.STATE=ACTIVITY.STATE.STATE_READY".
  • Duplicate apostrophes (') in comparising values. For example, "ACTIVITY.NAME='d''automatisation'".
  • To specify a where clause that refers to properties of name-value pairs, like custom properties, add a one-digit suffix (0-9) to the view name.
    For example, to have only tuples returned where an activity custom property "prop1" has the value "v1" or where an activity custom property "prop2" has the value v2", the where clause can look like "ACTIVITY_ATTRIBUTE1.NAME='prop1' AND ACTIVITY_ATTRIBUTE1.VALUE='v1' OR ACTIVITY_ATTRIBUTE2.NAME='prop2' AND ACTIVITY_ATTRIBUTE2.VALUE = 'v2'". For performance reasons, you should not use more than one "OR" construct; use "IN" instead.
    For example, to retrieve the values of custom properties "prop1" and "prop2" of all activity instances, the select clause can look like "DISTINCT ACTIVITY.AIID, ACTIVITY_ATTRIBUTE1.VALUE, ACTIVITY_ATTRIBUTE2.VALUE" and the where-clause "ACTIVITY_ATTRIBUTE1.NAME = 'prop1' AND ACTIVITY_ATTRIBUTE2.NAME = 'prop2'".

If a filter is not to be applied, null must be specified.

A whereClause must not be greater than 2047 bytes in UTF-8 format.

orderByClause - Orders the result of the stored query execution by the values of the columns you identify. Its syntax is an SQL order-by-clause. Each part of the order-by-clause separated by a comma must specify a property from the published views.

If you identify more that one property, the stored query execution result is ordered by the values of the first property you identify, then by the values of the second property, and so on.

If sort criteria are not to be applied, null must be specified. An orderByClause must not be greater than 254 bytes in UTF-8 format.

Note that sort criteria are applied on the server, that is, the locale of the server is used for sorting.

threshold - The maximum number of stored query execution result tuples to be returned from the server to the client. If a threshold is not to be applied, null must be specified.
timeZone - Specifies the time zone of the timestamp constants in the whereClause. If a timezone is not specified, UTC is assumed.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
InvalidLengthException
StoredQueryNameNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

getStoredQueryNames

public java.lang.String[] getStoredQueryNames()
                                       throws WorkItemManagerException,
                                              UnexpectedFailureException,
                                              java.rmi.RemoteException,
                                              javax.ejb.EJBException
Retrieves the names of stored queries persistently stored in the database. Refer to createStoredQuery for the creation of stored queries.

Specified by:
getStoredQueryNames in interface BusinessFlowManagerService
Returns:
String[] - An array of stored query names. If there are no stored queries defined, an empty array is returned.

Throws:
WorkItemManagerException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

deleteStoredQuery

public void deleteStoredQuery(java.lang.String storedQueryName)
                       throws EngineNotAuthorizedException,
                              EngineParameterNullException,
                              UnexpectedFailureException,
                              java.rmi.RemoteException,
                              javax.ejb.EJBException
Deletes the specified stored query. Only a business process administrator can delete a stored query. No error is signalled when the specified stored query does no longer exist.

Refer to createStoredQuery for the creation of stored queries.

Specified by:
deleteStoredQuery in interface BusinessFlowManagerService
Parameters:
storedQueryName - The name of the stored query to be deleted - refer to getStoredQueryNames for the retrieval of existing stored query names.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

getStoredQuery

public StoredQueryData getStoredQuery(java.lang.String storedQueryName)
                               throws ObjectDoesNotExistException,
                                      EngineParameterNullException,
                                      UnexpectedFailureException,
                                      java.rmi.RemoteException,
                                      javax.ejb.EJBException
Retrieves the specified stored query definition.

Specified by:
getStoredQuery in interface BusinessFlowManagerService
Parameters:
storedQueryName - The name of the stored query to be retrieved - refer to getStoredQueryNames for the retrieval of existing stored query names.

Returns:
StoredQueryData - The definition of the stored query retrieved - refer to StoredQueryData to view the stored query definition. If the specified stored query is not found, a null object is returned.

Throws:
ObjectDoesNotExistException
EngineParameterNullException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

query

public QueryResultSet query(java.lang.String storedQueryName,
                            java.lang.Integer skipTuples)
                     throws IdWrongFormatException,
                            ObjectDoesNotExistException,
                            EngineParameterNullException,
                            QueryInvalidOperandException,
                            QueryInvalidTimestampException,
                            QueryUndefinedParameterException,
                            QueryUnknownColumnException,
                            QueryUnknownOperatorException,
                            QueryUnknownTableException,
                            UnexpectedFailureException,
                            java.rmi.RemoteException,
                            javax.ejb.EJBException
Executes the stored query and returns the qualifying object properties. Only properties of objects are returned for which the logged-on user has a work item. Note that the business process administrator and system monitor have special rights and can access all objects.

Refer to createStoredQuery for the creation of stored queries.

Specified by:
query in interface BusinessFlowManagerService
Parameters:
storedQueryName - The name of the stored query to be executed - refer to getStoredQueryNames for the retrieval of existing stored query names.
skipTuples - The number of query result set tuples to be ignored and not to be returned to the caller. For example, a value of '5' means that the first 5 qualifying tuples are not returned. Use this parameter together with the threshold to implement paging in your client application.

If all qualifying tuples are to be returned, null or 0 must be specified.

Returns:
QueryResultSet - The qualifying object properties. If qualifying objects are not found, an empty query result set is returned. Refer to QueryResultSet for information on how to analyze the query result set.

Throws:
IdWrongFormatException
ObjectDoesNotExistException
EngineParameterNullException
QueryInvalidOperandException
QueryInvalidTimestampException
QueryUndefinedParameterException
QueryUnknownColumnException
QueryUnknownOperatorException
QueryUnknownTableException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

query

public QueryResultSet query(java.lang.String storedQueryName,
                            java.lang.Integer skipTuples,
                            java.lang.Integer threshold)
                     throws IdWrongFormatException,
                            ObjectDoesNotExistException,
                            EngineParameterNullException,
                            QueryInvalidOperandException,
                            QueryInvalidTimestampException,
                            QueryUndefinedParameterException,
                            QueryUnknownColumnException,
                            QueryUnknownOperatorException,
                            QueryUnknownTableException,
                            UnexpectedFailureException,
                            java.rmi.RemoteException,
                            javax.ejb.EJBException
Executes the stored query and returns the qualifying object properties. Only properties of objects are returned for which the logged-on user has a work item. Note that the business process administrator and system monitor have special rights and can access all objects.

Refer to createStoredQuery for the creation of stored queries.

Specified by:
query in interface BusinessFlowManagerService
Parameters:
storedQueryName - The name of the stored query to be executed - refer to getStoredQueryNames for the retrieval of existing stored query names.
skipTuples - The number of query result set tuples to be ignored and not to be returned to the caller. For example, a value of '5' means that the first 5 qualifying tuples are not returned. Use this parameter together with the threshold to implement paging in your client application.

If all qualifying tuples are to be returned, null or 0 must be specified.

threshold - The maximum number of result set tuples to be returned from the server to the client. If the threshold is to be taken from the stored query definition, use query or specify null.

Returns:
QueryResultSet - The qualifying object properties. If qualifying objects are not found, an empty query result set is returned. Refer to QueryResultSet for information on how to analyze the query result set.

Throws:
IdWrongFormatException
ObjectDoesNotExistException
EngineParameterNullException
QueryInvalidOperandException
QueryInvalidTimestampException
QueryUndefinedParameterException
QueryUnknownColumnException
QueryUnknownOperatorException
QueryUnknownTableException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0.1

getWorkItems

public WorkItemData[] getWorkItems(java.lang.String identifier)
                            throws IdWrongFormatException,
                                   IdWrongTypeException,
                                   WorkItemManagerException,
                                   UnexpectedFailureException,
                                   java.rmi.RemoteException,
                                   javax.ejb.EJBException
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. Note that the business process administrator has special rights and can access all objects, even of other users.

Specified by:
getWorkItems in interface BusinessFlowManagerService
Parameters:
identifier - A string representation of the process or activity instance object ID. The string is used to identify the process instance or activity instance for which work item assignments are to be retrieved.

Returns:
WorkItemData[] - An array of work items. If no work items are found, an empty array is returned. Refer to WorkItemData to view the work item properties.

Throws:
IdWrongFormatException
IdWrongTypeException
WorkItemManagerException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0

getWorkItems

public WorkItemData[] getWorkItems(AIID aiid)
                            throws IdWrongFormatException,
                                   UnexpectedFailureException,
                                   WorkItemManagerException,
                                   java.rmi.RemoteException,
                                   javax.ejb.EJBException
Retrieves work item assignments for the logged-on user and the specified activity instance using the activity instance ID. Note that the business process administrator has special rights and can access all objects, even of other users.

Specified by:
getWorkItems in interface BusinessFlowManagerService
Parameters:
aiid - The object ID of the activity instance for which work item assignments are to be retrieved.

Returns:
WorkItemData[] - An array of work items. If no work items are found, an empty array is returned. Refer to WorkItemData to view the work item properties.

Throws:
IdWrongFormatException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - introduced in 5.0

getWorkItems

public WorkItemData[] getWorkItems(PIID piid)
                            throws IdWrongFormatException,
                                   UnexpectedFailureException,
                                   WorkItemManagerException,
                                   java.rmi.RemoteException,
                                   javax.ejb.EJBException
Retrieves work item assignments for the logged-on user and the specified process instance using the process instance ID. Note that the business process administrator has special rights and can access all objects, even of other users.

Specified by:
getWorkItems in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance for which work item assignments are to be retrieved.

Returns:
WorkItemData[] - An array of work items. If no work items are found, an empty array is returned. Refer to WorkItemData to view the work item properties.

Throws:
IdWrongFormatException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - introduced in 5.0

forceRetry

public void forceRetry(java.lang.String aiid,
                       boolean continueOnError)
                throws EngineNotAuthorizedException,
                       EngineWrongKindException,
                       EngineWrongMessageTypeException,
                       EngineWrongStateException,
                       IdWrongFormatException,
                       IdWrongTypeException,
                       ObjectDoesNotExistException,
                       UnexpectedFailureException,
                       java.rmi.RemoteException,
                       javax.ejb.EJBException
Forces the repetition of a stopped activity instance using a string representation of the activity instance ID.

The activity instance must be in the stopped execution state and the associated process instance must be in the running execution state.

The caller must be an administrator of the associated process instance.

Since no input message is passed, the process engine uses the input message available to the system.

Specified by:
forceRetry in interface BusinessFlowManagerService
Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance to be retried.
continueOnError - A flag that indicates what should happen in case of an error, that is, when a system exception or an unhandled fault occurs. True states that navigation should continue, that is, the activity instance is set into execution state failed and the error is propagated to the associated process instance. False states that the activity instance should stay in execution state stopped.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

forceRetry

public void forceRetry(AIID aiid,
                       boolean continueOnError)
                throws EngineNotAuthorizedException,
                       EngineWrongKindException,
                       EngineWrongMessageTypeException,
                       EngineWrongStateException,
                       IdWrongFormatException,
                       ObjectDoesNotExistException,
                       UnexpectedFailureException,
                       java.rmi.RemoteException,
                       javax.ejb.EJBException
Forces the repetition of a stopped activity instance using the activity instance ID.

The activity instance must be in the stopped execution state and the associated process instance must be in the running execution state.

The caller must be an administrator of the associated process instance.

Since no input message is passed, the process engine uses the input message available to the system.

Specified by:
forceRetry in interface BusinessFlowManagerService
Parameters:
aiid - The object ID to identify the activity instance to be retried.
continueOnError - A flag that indicates what should happen in case of an error, that is, when a system exception or an unhandled fault occurs. True states that navigation should continue, that is, the activity instance is set into execution state failed and the error is propagated to the associated process instance. False states that the activity instance should stay in execution state stopped.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

forceRetry

public void forceRetry(java.lang.String aiid,
                       ClientObjectWrapper inputMessage,
                       boolean continueOnError)
                throws EngineNotAuthorizedException,
                       EngineWrongKindException,
                       EngineWrongMessageTypeException,
                       EngineWrongStateException,
                       IdWrongFormatException,
                       IdWrongTypeException,
                       ObjectDoesNotExistException,
                       UnexpectedFailureException,
                       java.rmi.RemoteException,
                       javax.ejb.EJBException
Forces the repetition of a stopped activity instance using a string representation of the activity instance ID and an input message.

The activity instance must be in the stopped execution state and the associated process instance must be in the running execution state.

The caller must be an administrator of the associated process instance.

Optionally, an input message may be provided. The process engine uses the input message provided.

Specified by:
forceRetry in interface BusinessFlowManagerService
Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance to be retried.
inputMessage - The input message that specifies the values to be used by the activity instance. If input is not to be provided, null must be specified; the process engine then uses the input available to the system. An empty ClientObjectWrapper causes the input message to be set to null. The object wrapped by the ClientObjectWrapper must be serializable.
continueOnError - A flag that indicates what should happen in case of an error, that is, when a system exception or an unhandled fault occurs. True states that navigation should continue, that is, the activity instance is set into execution state failed and the error is propagated to the associated process instance. False states that the activity instance should stay in execution state stopped.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

forceRetry

public void forceRetry(AIID aiid,
                       ClientObjectWrapper inputMessage,
                       boolean continueOnError)
                throws EngineNotAuthorizedException,
                       EngineWrongKindException,
                       EngineWrongMessageTypeException,
                       EngineWrongStateException,
                       IdWrongFormatException,
                       ObjectDoesNotExistException,
                       UnexpectedFailureException,
                       java.rmi.RemoteException,
                       javax.ejb.EJBException
Forces the repetition of a stopped activity instance using the activity instance ID and an input message.

The activity instance must be in the stopped execution state and the associated process instance must be in the running execution state.

The caller must be an administrator of the associated process instance.

Optionally, an input message may be provided. The process engine then uses the input message provided.

Specified by:
forceRetry in interface BusinessFlowManagerService
Parameters:
aiid - The object ID to identify the activity instance to be retried.
inputMessage - The input message that specifies the values to be used by the activity instance. If input is not to be provided, null must be specified; the process engine then uses the input available to the system. An empty ClientObjectWrapper causes the input message to be set to null. The object wrapped by the ClientObjectWrapper must be serializable.
continueOnError - A flag that indicates what should happen in case of an error, that is, when a system exception or an unhandled fault occurs. True states that navigation should continue, that is, the activity instance is set into execution state failed and the error is propagated to the associated process instance. False states that the activity instance should stay in execution state stopped.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

forceComplete

public void forceComplete(java.lang.String aiid,
                          boolean continueOnError)
                   throws EngineNotAuthorizedException,
                          EngineWrongKindException,
                          EngineWrongStateException,
                          IdWrongFormatException,
                          IdWrongTypeException,
                          InvalidLengthException,
                          ObjectDoesNotExistException,
                          UnexpectedFailureException,
                          java.rmi.RemoteException,
                          javax.ejb.EJBException
Forces the completion of a stopped activity instance using a string representation of the activity instance ID.

The activity instance must be in the stopped execution state and the associated process instance must be in the running execution state.

The caller must be an administrator of the associated process instance.

Forcing the completion of an activity instance states that navigation of the process instance can continue.

Depending on the stored result of user processing, output or fault message values are used to continue navigation.

If user processing did not complete successfully, that is, if a fault message has been set, the activity instance is put into the failed execution state when the fault is handled or when the continueOnError flag is set to true. It remains in the stopped execution state when the fault is not handled and the continueOnError flag is set to false.

Note that an output or fault message does not need to be set; navigation can continue with an empty output message.

Specified by:
forceComplete in interface BusinessFlowManagerService
Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance to be completed.
continueOnError - A flag that indicates what should happen in case of an error, that is, when a system exception or an unhandled fault occurs. True states that navigation should continue, that is, the activity instance is set into execution state failed and the error is propagated to the associated process instance. False states that the activity instance should stay in execution state stopped.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

forceComplete

public void forceComplete(AIID aiid,
                          boolean continueOnError)
                   throws EngineNotAuthorizedException,
                          EngineWrongKindException,
                          EngineWrongStateException,
                          IdWrongFormatException,
                          InvalidLengthException,
                          ObjectDoesNotExistException,
                          UnexpectedFailureException,
                          java.rmi.RemoteException,
                          javax.ejb.EJBException
Forces the completion of a stopped activity instance using the activity instance ID.

The activity instance must be in the stopped execution state and the associated process instance must be in the running execution state.

The caller must be an administrator of the associated process instance.

Forcing the completion of an activity instance states that navigation of the process instance can continue.

Depending on the stored result of user processing, output or fault message values are used to continue navigation.

If user processing did not complete successfully, that is, if a fault message has been set, the activity instance is put into the failed execution state when the fault is handled or when the continueOnError flag is set to true. It remains in the stopped execution state when the fault is not handled and the continueOnError flag is set to false.

Note that an output or fault message does not need to be set; navigation can continue with an empty output message.

Specified by:
forceComplete in interface BusinessFlowManagerService
Parameters:
aiid - The object ID to identify the activity instance to be completed.
continueOnError - A flag that indicates what should happen in case of an error, that is, when a system exception or an unhandled fault occurs. True states that navigation should continue, that is, the activity instance is set into execution state failed and the error is propagated to the associated process instance. False states that the activity instance should stay in execution state stopped.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

forceComplete

public void forceComplete(java.lang.String aiid,
                          ClientObjectWrapper output,
                          boolean continueOnError)
                   throws EngineNotAuthorizedException,
                          EngineWrongKindException,
                          EngineWrongMessageTypeException,
                          EngineWrongStateException,
                          IdWrongFormatException,
                          IdWrongTypeException,
                          InvalidLengthException,
                          ObjectDoesNotExistException,
                          UnexpectedFailureException,
                          java.rmi.RemoteException,
                          javax.ejb.EJBException
Forces the completion of a stopped activity instance using a string representation of the activity instance ID and an output message.

The activity instance must be in the stopped execution state and the associated process instance must be in the running execution state.

The caller must be an administrator of the associated process instance.

Completion of an activity instance means that user processing finished and that navigation of the process instance can continue. An output message is passed to denote the successful execution of user processing. The activity instance is put into the finished execution state.

Output message values are used to continue navigation.

Specified by:
forceComplete in interface BusinessFlowManagerService
Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance to be completed.
output - The output message that denotes the successful result of processing. If output is not to be provided, null must be specified; the process engine then uses the output available to the system. The object wrapped by the ClientObjectWrapper must be serializable.
Any previously set output or fault message is ignored.
continueOnError - A flag that indicates what should happen in case of an error, that is, when a system exception or an unhandled fault occurs. True states that navigation should continue, that is, the activity instance is set into execution state failed and the error is propagated to the associated process instance. False states that the activity instance should stay in execution state stopped.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

forceComplete

public void forceComplete(AIID aiid,
                          ClientObjectWrapper output,
                          boolean continueOnError)
                   throws EngineNotAuthorizedException,
                          EngineWrongKindException,
                          EngineWrongMessageTypeException,
                          EngineWrongStateException,
                          IdWrongFormatException,
                          InvalidLengthException,
                          ObjectDoesNotExistException,
                          UnexpectedFailureException,
                          java.rmi.RemoteException,
                          javax.ejb.EJBException
Forces the completion of a stopped activity instance using the activity instance ID and an output messsage.

The activity instance must be in the stopped execution state and the associated process instance must be in the running execution state.

The caller must be an administrator of the associated process instance.

Completion of an activity instance means that user processing finished and that navigation of the process instance can continue. An output message is passed to denote the successful execution of user processing. The activity instance is put into the finished execution state.

Output message values are used to continue navigation.

Specified by:
forceComplete in interface BusinessFlowManagerService
Parameters:
aiid - The object ID to identify the activity instance to be completed.
output - The output message that denotes the successful result of processing. If output is not to be provided, null must be specified; the process engine then uses the output available to the system. The object wrapped by the ClientObjectWrapper must be serializable.
Any previously set output or fault message is ignored.
continueOnError - A flag that indicates what should happen in case of an error, that is, when a system exception or an unhandled fault occurs. True states that navigation should continue, that is, the activity instance is set into execution state failed and the error is propagated to the associated process instance. False states that the activity instance should stay in execution state stopped.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

forceComplete

public void forceComplete(java.lang.String aiid,
                          ClientObjectWrapper message,
                          java.lang.String faultName,
                          boolean continueOnError)
                   throws EngineNotAuthorizedException,
                          EngineParameterNullException,
                          EngineWrongKindException,
                          EngineWrongMessageTypeException,
                          EngineWrongStateException,
                          IdWrongFormatException,
                          IdWrongTypeException,
                          InvalidLengthException,
                          ObjectDoesNotExistException,
                          UnexpectedFailureException,
                          java.rmi.RemoteException,
                          javax.ejb.EJBException
Forces the completion of a stopped activity instance using a string representation of the activity instance ID and states the actual result of user processing.

The activity instance must be in the stopped execution state and the associated process instance must be in the running execution state.

The caller must be an administrator of the associated process instance.

Forcing the completion of an activity instance states that navigation of the process instance can continue.

An output message is passed to denote the successful execution of user processing. The activity instance is put into the finished execution state.

If user processing did not complete successfully, that is, if a fault message is passed, the activity instance is put into the failed execution state when the fault is handled or when the continueOnError flag is set to true. It remains in the stopped execution state when the fault is not handled and the continueOnError flag is set to false.

Depending on the result of user processing, output or fault message values are used to continue navigation.

Specified by:
forceComplete in interface BusinessFlowManagerService
Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance to be completed.
message - The output or fault message. If an output or fault is not to be provided, null must be specified; the process engine then uses the output or fault available to the system. The object wrapped by the ClientObjectWrapper must be serializable.
If specified, any previously set output or fault message is ignored.
faultName - The name of the fault, if any. If a fault name is specified, the fault must have been defined for the activity. Refer to getFaultNames. Note that the structure of a BPEL fault name is a QName.
continueOnError - A flag that indicates what should happen in case of an error, that is, when a system exception or an unhandled fault occurs. True states that navigation should continue, that is, the activity instance is set into execution state failed and the error is propagated to the associated process instance. False states that the activity instance should stay in execution state stopped.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

forceComplete

public void forceComplete(AIID aiid,
                          ClientObjectWrapper message,
                          java.lang.String faultName,
                          boolean continueOnError)
                   throws EngineNotAuthorizedException,
                          EngineParameterNullException,
                          EngineWrongKindException,
                          EngineWrongMessageTypeException,
                          EngineWrongStateException,
                          IdWrongFormatException,
                          InvalidLengthException,
                          ObjectDoesNotExistException,
                          UnexpectedFailureException,
                          java.rmi.RemoteException,
                          javax.ejb.EJBException
Forces the completion of a stopped activity instance using the activity instance ID and states the actual result of user processing.

The activity instance must be in the stopped execution state and the associated process instance must be in the running execution state.

The caller must be an administrator of the associated process instance.

Forcing the completion of an activity instance states that navigation of the process instance can continue.

An output message is passed to denote the successful execution of user processing. The activity instance is put into the finished execution state.

If user processing did not complete successfully, that is, if a fault message is passed, the activity instance is put into the failed execution state when the fault is handled or when the continueOnError flag is set to true. It remains in the stopped execution state when the fault is not handled and the continueOnError flag is set to false.

Depending on the result of user processing, output or fault message values are used to continue navigation.

Specified by:
forceComplete in interface BusinessFlowManagerService
Parameters:
aiid - The object ID to identify the activity instance to be completed.
message - The output or fault message. If an output or fault is not to be provided, null must be specified; the process engine then uses the output or fault available to the system. The object wrapped by the ClientObjectWrapper must be serializable.

If specified, any previously set output or fault message is ignored.

faultName - The name of the fault, if any. If a fault name is specified, the fault must have been defined for the activity. Refer to getFaultNames. Note that the structure of a BPEL fault name is a QName.
continueOnError - A flag that indicates what should happen in case of an error, that is, when a system exception or an unhandled fault occurs. True states that navigation should continue, that is, the activity instance is set into execution state failed and the error is propagated to the associated process instance. False states that the activity instance should stay in execution state stopped.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getAllActivities

public QueryResultSet getAllActivities(java.lang.String piid,
                                       java.util.TimeZone timezone)
                                throws EngineNotAuthorizedException,
                                       IdWrongFormatException,
                                       IdWrongTypeException,
                                       ObjectDoesNotExistException,
                                       UnexpectedFailureException,
                                       WorkItemManagerException,
                                       java.rmi.RemoteException,
                                       javax.ejb.EJBException
Queries pre-defined activity instance properties of activities directly contained in the specified process instance using a string representation of the process instance ID. Following properties of an activity instance (columns of the query result set) are returned in the stated sequence:
  1. ID
  2. Name
  3. Execution state
  4. Kind
  5. Activation time

Note that only business-relevant activities are returned.

The process instance can be in any execution state. The caller must have reader authority for the process instance, be the process administrator, or be the business process administrator.

Specified by:
getAllActivities in interface BusinessFlowManagerService
Parameters:
piid - The String representation of the object ID of the process instance.
timezone - The timezone of all timestamp properties returned. If a timezone is not specified, timestamps are returned in UTC.

Returns:
QueryResultSet - An object containing the query result. If qualifying tuples are not found, an empty query result set is returned. Refer to QueryResultSet for information on how to analyze the query result set.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getAllActivities

public QueryResultSet getAllActivities(PIID piid,
                                       java.util.TimeZone timezone)
                                throws EngineNotAuthorizedException,
                                       IdWrongFormatException,
                                       ObjectDoesNotExistException,
                                       UnexpectedFailureException,
                                       WorkItemManagerException,
                                       java.rmi.RemoteException,
                                       javax.ejb.EJBException
Queries pre-defined activity instance properties of activities directly contained in the specified process instance using the process instance ID. Following properties of an activity instance (columns of the query result set) are returned in the stated sequence:
  1. ID
  2. Name
  3. Execution state
  4. Kind
  5. Activation time

Note that only business-relevant activities are returned.

The process instance can be in any execution state. The caller must have reader authority for the process instance, be the process administrator, or be the business process administrator.

Specified by:
getAllActivities in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance.
timezone - The timezone of all timestamp properties returned. If a timezone is not specified, timestamps are returned in UTC.

Returns:
QueryResultSet - An object containing the query result. If qualifying tuples are not found, an empty query result set is returned. Refer to QueryResultSet for information on how to analyze the query result set.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getAllWorkItems

public WorkItemData[] getAllWorkItems(java.lang.String identifier)
                               throws EngineNotAuthorizedException,
                                      IdWrongFormatException,
                                      IdWrongTypeException,
                                      ObjectDoesNotExistException,
                                      UnexpectedFailureException,
                                      WorkItemManagerException,
                                      java.rmi.RemoteException,
                                      javax.ejb.EJBException
Retrieves all work item assignments associated to the specified process or activity instance using a string representation of the process or activity instance ID.

The activity or process instance can be in any execution state. The caller must have reader authority for the process instance, be the process administrator, or be the business process administrator.

Specified by:
getAllWorkItems in interface BusinessFlowManagerService
Parameters:
identifier - A string representation of the process or activity instance object ID. The string is used to identify the process instance or activity instance.

Returns:
WorkItemData[] - An array of work items. If no work items are found, an empty array is returned. Refer to WorkItemData to view the work item properties.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getAllWorkItems

public WorkItemData[] getAllWorkItems(PIID piid)
                               throws EngineNotAuthorizedException,
                                      IdWrongFormatException,
                                      ObjectDoesNotExistException,
                                      UnexpectedFailureException,
                                      WorkItemManagerException,
                                      java.rmi.RemoteException,
                                      javax.ejb.EJBException
Retrieves all work item assignments associated to the specified process instance using the process instance ID.

The process instance can be in any execution state. The caller must have reader authority for the process instance, be the process administrator, or be the business process administrator.

Specified by:
getAllWorkItems in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance.

Returns:
WorkItemData[] - An array of work items. If no work items are found, an empty array is returned. Refer to WorkItemData to view the work item properties.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getAllWorkItems

public WorkItemData[] getAllWorkItems(AIID aiid)
                               throws EngineNotAuthorizedException,
                                      IdWrongFormatException,
                                      ObjectDoesNotExistException,
                                      UnexpectedFailureException,
                                      WorkItemManagerException,
                                      java.rmi.RemoteException,
                                      javax.ejb.EJBException
Retrieves all work item assignments associated to the specified activity instance using the activity instance ID.

The activity instance and the associated process instance can be in any execution state. The caller must have reader authority for the associated process instance, be the process administrator, or be the business process administrator.

Specified by:
getAllWorkItems in interface BusinessFlowManagerService
Parameters:
aiid - The object ID of the activity instance.

Returns:
WorkItemData[] - An array of work items. If no work items are found, an empty array is returned. Refer to WorkItemData to view the work item properties.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
WorkItemManagerException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0 - FDML related exceptions removed

getWorkListActions

public int[] getWorkListActions()
                         throws java.rmi.RemoteException,
                                javax.ejb.EJBException
Deprecated. 

Returns the actions that can be called by the logged-on user related to worklists.

Specified by:
getWorkListActions in interface BusinessFlowManagerService
Returns:
int[] - An array of worklist actions. Refer to WorkListActions for the set of available actions.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.0

getStartActivities

public ActivityServiceTemplateData[] getStartActivities(java.lang.String ptid)
                                                 throws EngineNotAuthorizedException,
                                                        IdWrongFormatException,
                                                        IdWrongTypeException,
                                                        ObjectDoesNotExistException,
                                                        UnexpectedFailureException,
                                                        java.rmi.RemoteException,
                                                        javax.ejb.EJBException
Returns information about activities that can start a process instance from the specified process template using a string representation of the process template ID.

The caller must be authorized for the process template.

Specified by:
getStartActivities in interface BusinessFlowManagerService
Parameters:
ptid - The string representation of the process template object ID. This is used to identify the process template.

Returns:
ActivityServiceTemplateData[] - An array of activity service templates. If no information is available for the logged-on user, an empty array is returned. Refer to ActivityServiceTemplateData to view the properties.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getStartActivities

public ActivityServiceTemplateData[] getStartActivities(PTID ptid)
                                                 throws EngineNotAuthorizedException,
                                                        ObjectDoesNotExistException,
                                                        UnexpectedFailureException,
                                                        java.rmi.RemoteException,
                                                        javax.ejb.EJBException
Returns information about activities that can start a process instance from the specified process template using the process template ID.

The caller must be authorized for the process template.

Specified by:
getStartActivities in interface BusinessFlowManagerService
Parameters:
ptid - The object ID of the process template.

Returns:
ActivityServiceTemplateData[] - An array of activity service templates. If no information is available for the logged-on user, an empty array is returned. Refer to ActivityServiceTemplateData to view the properties.

Throws:
EngineNotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getWaitingActivities

public ActivityServiceTemplateData[] getWaitingActivities(java.lang.String piid)
                                                   throws EngineNotAuthorizedException,
                                                          IdWrongFormatException,
                                                          IdWrongTypeException,
                                                          ObjectDoesNotExistException,
                                                          UnexpectedFailureException,
                                                          java.rmi.RemoteException,
                                                          javax.ejb.EJBException
Returns information about activities of a process instance, that are in the waiting execution state. The process instance is identified using a string representation of the process instance ID.

The caller must be authorized for the process instance.

Specified by:
getWaitingActivities in interface BusinessFlowManagerService
Parameters:
piid - The string representation of the process instance object ID. This is used to identify the process instance.

Returns:
ActivityServiceTemplateData[] - An array of activity service templates. If no information is available for the logged-on user, an empty array is returned. Refer to ActivityServiceTemplateData to view the properties.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

getWaitingActivities

public ActivityServiceTemplateData[] getWaitingActivities(PIID piid)
                                                   throws EngineNotAuthorizedException,
                                                          IdWrongFormatException,
                                                          ObjectDoesNotExistException,
                                                          UnexpectedFailureException,
                                                          java.rmi.RemoteException,
                                                          javax.ejb.EJBException
Returns information about activities of a process instance, that are in the waiting execution state. The process instance is identified using the process instance ID.

The caller must be authorized for the process instance.

Specified by:
getWaitingActivities in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance.

Returns:
ActivityServiceTemplateData[] - An array of activity service templates. If no information is available for the logged-on user, an empty array is returned. Refer to ActivityServiceTemplateData to view the properties.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

sendMessage

public PIID sendMessage(java.lang.String vtid,
                        java.lang.String atid,
                        ClientObjectWrapper message)
                 throws CreateFailedException,
                        EngineNotAuthorizedException,
                        EngineProcessModelStoppedException,
                        FaultReplyException,
                        IdWrongFormatException,
                        IdWrongTypeException,
                        MissingPartsException,
                        ObjectDoesNotExistException,
                        ProcessException,
                        ProcessInstanceNotUniqueException,
                        UnexpectedFailureException,
                        java.rmi.RemoteException,
                        javax.ejb.EJBException
Sends the specified message to the specified activity service using a string representation of the activity service template ID and the activity template ID. The process instance that contains the activity service to be called is identified by the correlation set values contained in the message. If the process instance does not yet exist and the messsage is send to a starting receive or pick activity, then the process instance is automatically created.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

The caller must be a potential owner of the associated activity or a process administrator.

Specified by:
sendMessage in interface BusinessFlowManagerService
Parameters:
vtid - The string representation of the activity service template object ID. This is used to identify the service.
atid - A string representation of the activity template ID. This is used to identify the activity the service belongs to.
message - The message. The object wrapped by the ClientObjectWrapper must be serializable.

Returns:
PIID - The ID of the process instance created or identified.

Throws:
CreateFailedException
EngineNotAuthorizedException
EngineProcessModelStoppedException
FaultReplyException
IdWrongFormatException
IdWrongTypeException
MissingPartsException
ObjectDoesNotExistException
ProcessException
ProcessInstanceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1.1

sendMessage

public PIID sendMessage(VTID vtid,
                        ATID atid,
                        ClientObjectWrapper message)
                 throws CreateFailedException,
                        EngineNotAuthorizedException,
                        EngineProcessModelStoppedException,
                        FaultReplyException,
                        IdWrongFormatException,
                        MissingPartsException,
                        ObjectDoesNotExistException,
                        ProcessException,
                        ProcessInstanceNotUniqueException,
                        UnexpectedFailureException,
                        java.rmi.RemoteException,
                        javax.ejb.EJBException
Sends the specified message to the specified activity service using the activity service template ID and the activity template ID. The process instance that contains the activity service to be called is identified by the correlation set values contained in the message. If the process instance does not yet exist and the messsage is send to a starting receive or pick activity, then the process instance is automatically created.

A process instance is only created when the currently valid version of the specified process template is started and when it belongs to a started application.

The caller must be a potential owner of the associated activity or a process administrator.

Specified by:
sendMessage in interface BusinessFlowManagerService
Parameters:
vtid - The object ID of the activity service template. This is used to identify the service.
atid - The object ID of the activity the activity service template belongs to.
message - The message. The object wrapped by the ClientObjectWrapper must be serializable.

Returns:
PIID - The ID of the process instance created or identified.

Throws:
CreateFailedException
EngineNotAuthorizedException
EngineProcessModelStoppedException
FaultReplyException
IdWrongFormatException
MissingPartsException
ObjectDoesNotExistException
ProcessException
ProcessInstanceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1.1

sendMessage

public void sendMessage(java.lang.String piid,
                        java.lang.String vtid,
                        java.lang.String atid,
                        ClientObjectWrapper message)
                 throws EngineNotAuthorizedException,
                        IdAndCorrelationSetMismatchException,
                        IdWrongFormatException,
                        IdWrongTypeException,
                        MissingPartsException,
                        ObjectDoesNotExistException,
                        ProcessException,
                        ProcessInstanceNotUniqueException,
                        UnexpectedFailureException,
                        java.rmi.RemoteException,
                        javax.ejb.EJBException
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. The process instance identified by the object ID must be the same process instance that is identified by the correlation set values in the message.

The caller must be a potential owner of the associated activity or a process administrator.

Specified by:
sendMessage in interface BusinessFlowManagerService
Parameters:
piid - The string representation of the process instance object ID. This is used to identify the process instance.
vtid - The string representation of the activity service template object ID. This is used to identify the service.
atid - A string representation of the activity template ID. This is used to identify the activity the service belongs to.
message - The message. The object wrapped by the ClientObjectWrapper must be serializable.

Throws:
EngineNotAuthorizedException
IdAndCorrelationSetMismatchException
IdWrongFormatException
IdWrongTypeException
MissingPartsException
ObjectDoesNotExistException
ProcessException
ProcessInstanceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1

sendMessage

public void sendMessage(PIID piid,
                        VTID vtid,
                        ATID atid,
                        ClientObjectWrapper message)
                 throws EngineNotAuthorizedException,
                        IdAndCorrelationSetMismatchException,
                        IdWrongFormatException,
                        MissingPartsException,
                        ObjectDoesNotExistException,
                        ProcessException,
                        ProcessInstanceNotUniqueException,
                        UnexpectedFailureException,
                        java.rmi.RemoteException,
                        javax.ejb.EJBException
Sends the specified message to the specified activity service and process instance using the process instance, activity service template, and activity template IDs. The process instance identified by the object ID must be the same process instance that is identified by the correlation set values in the message.

The caller must be a potential owner of the associated activity or a process administrator.

Specified by:
sendMessage in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance, a message is to be send to.
vtid - The object ID of the activity service template. This is used to identify the service.
atid - The object ID of the activity the activity service template belongs to.
message - The message. The object wrapped by the ClientObjectWrapper must be serializable.

Throws:
EngineNotAuthorizedException
IdAndCorrelationSetMismatchException
IdWrongFormatException
MissingPartsException
ObjectDoesNotExistException
ProcessException
ProcessInstanceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1

sendMessage

public PIID sendMessage(java.lang.String processTemplateName,
                        java.lang.String nameSpace,
                        java.lang.String portType,
                        java.lang.String operation,
                        ClientObjectWrapper message)
                 throws CreateFailedException,
                        EngineNotAuthorizedException,
                        EngineParameterNullException,
                        EngineProcessModelStoppedException,
                        FaultReplyException,
                        IdAndCorrelationSetMismatchException,
                        IdWrongFormatException,
                        MissingPartsException,
                        ObjectDoesNotExistException,
                        ProcessException,
                        ProcessInstanceNotUniqueException,
                        UnexpectedFailureException,
                        java.rmi.RemoteException,
                        javax.ejb.EJBException
Sends the specified message to the specified process template, using the namespace, port type and operation. The process template is identified by its name.

Specified by:
sendMessage in interface BusinessFlowManagerService
Parameters:
processTemplateName - The name of a process template, a message is to be send to.
nameSpace - The target namespace of the BPEL process.
portType - The name of the port type.
operation - The operation name of the service.
message - The message. The object wrapped by the ClientObjectWrapper must be serializable.

Returns:
PIID - The ID of the process instance created or identified.

Throws:
CreateFailedException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessModelStoppedException
FaultReplyException
IdAndCorrelationSetMismatchException
IdWrongFormatException
MissingPartsException
ObjectDoesNotExistException
ProcessException
ProcessInstanceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

sendMessage

public void sendMessage(java.lang.String processTemplateName,
                        java.lang.String nameSpace,
                        java.lang.String portType,
                        java.lang.String operation,
                        ClientObjectWrapper message,
                        ReplyContextWrapper replyContext)
                 throws EngineNotAuthorizedException,
                        EngineParameterNullException,
                        IdAndCorrelationSetMismatchException,
                        IdWrongFormatException,
                        MissingPartsException,
                        ObjectDoesNotExistException,
                        ProcessException,
                        ProcessInstanceNotUniqueException,
                        UnexpectedFailureException,
                        java.rmi.RemoteException,
                        javax.ejb.EJBException
Sends the specified message to the specified process template, using the namespace, port type and operation. The process template is identified by its name.

Specified by:
sendMessage in interface BusinessFlowManagerService
Parameters:
processTemplateName - The name of a process template, a message is to be send to.
nameSpace - The target namespace of the BPEL process.
portType - The name of the port type.
operation - The operation name of the service.
message - The message. The object wrapped by the ClientObjectWrapper must be serializable.

replyContext - The reply context that is to be used to send the result back to the caller.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
IdAndCorrelationSetMismatchException
IdWrongFormatException
MissingPartsException
ObjectDoesNotExistException
ProcessException
ProcessInstanceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

sendMessage

public 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)
                 throws EngineNotAuthorizedException,
                        EngineParameterNullException,
                        IdAndCorrelationSetMismatchException,
                        IdWrongFormatException,
                        MissingPartsException,
                        ObjectDoesNotExistException,
                        ProcessException,
                        ProcessInstanceNotUniqueException,
                        UnexpectedFailureException,
                        java.rmi.RemoteException,
                        javax.ejb.EJBException
Sends the specified message to the specified process template, using the namespace, port type and operation. The process template is identified by its name.

Specified by:
sendMessage in interface BusinessFlowManagerService
Parameters:
processTemplateName - The name of a process template, a message is to be send to.
nameSpace - The target namespace of the BPEL process.
portType - The name of the port type.
operation - The operation name of the service.
message - The message. The object wrapped by the ClientObjectWrapper must be serializable.

replyContext - The reply context that is to be used to send the result back to the caller.

invocationCount - The invocation count that specifies the number of invocation attempts. The first attempt should be 1, the second 2, and so on. This count has to be maintained by the caller and has to be incremented after each unsuccesful invocation attempt, that is, when the request ended with an exception. If the caller is an MDB that works on behalf of a received JMS message, the JMSXDeliveryCount property of the message can be used to count the invocation attempts. A value of 0 indicates that the invocation count is not known to the caller.
requestId - An ID to identify the request uniquely. If the caller is an MDB that works on behalf of a received JMS message, the JMSMessageId can be used as the requestId. A value of null implies that a unique requestId is not known to the caller.

Throws:
EngineNotAuthorizedException
EngineParameterNullException
IdAndCorrelationSetMismatchException
IdWrongFormatException
MissingPartsException
ObjectDoesNotExistException
ProcessException
ProcessInstanceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

getActivityServiceTemplate

public ActivityServiceTemplateData getActivityServiceTemplate(java.lang.String vtid,
                                                              java.lang.String atid)
                                                       throws EngineNotAuthorizedException,
                                                              IdWrongFormatException,
                                                              IdWrongTypeException,
                                                              ObjectDoesNotExistException,
                                                              UnexpectedFailureException,
                                                              java.rmi.RemoteException,
                                                              javax.ejb.EJBException
Retrieves the specified activity service template using string representations of the associated object IDs.

The caller must have at least reader authority for the associated activity or be a process administrator.

Specified by:
getActivityServiceTemplate in interface BusinessFlowManagerService
Parameters:
vtid - A string representation of the activity service template ID. This is used to identify the service to be retrieved.
atid - A string representation of the activity template ID. This is used to identify the activity the service belongs to.

Returns:
ActivityServiceTemplateData - The activity service template information. Refer to ActivityServiceTemplateData to view the properties of an activity service template.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1

getActivityServiceTemplate

public ActivityServiceTemplateData getActivityServiceTemplate(VTID vtid,
                                                              ATID atid)
                                                       throws EngineNotAuthorizedException,
                                                              IdWrongFormatException,
                                                              ObjectDoesNotExistException,
                                                              UnexpectedFailureException,
                                                              java.rmi.RemoteException,
                                                              javax.ejb.EJBException
Retrieves the specified activity service template using the associated object IDs.

The caller must have at least reader authority for the associated activity or be a process administrator.

Specified by:
getActivityServiceTemplate in interface BusinessFlowManagerService
Parameters:
vtid - The object ID of the activity service template to be retrieved.
atid - The object ID of the activity the activity service template belongs to.

Returns:
ActivityServiceTemplateData - The activity service template information. Refer to ActivityServiceTemplateData to view the properties of an activity service template.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1

isBusinessProcessAdministrator

public boolean isBusinessProcessAdministrator()
                                       throws java.rmi.RemoteException,
                                              javax.ejb.EJBException
Indicates whether the logged-on user is a business process administrator (system administrator).

In general, authorization is granted to persons explicitly when a process model is defined or implicitly, for example, by starting a process instance. Above that, special authority is granted to a person playing the role of a business process (system) administrator. A business process administrator has all priviledges.

Specified by:
isBusinessProcessAdministrator in interface BusinessFlowManagerService
Returns:
boolean - True states that the logged-on user is a business process administrator. False states that the logged-on user is no business process administrator.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1

isBusinessProcessMonitor

public boolean isBusinessProcessMonitor()
                                 throws java.rmi.RemoteException,
                                        javax.ejb.EJBException
Indicates whether the logged-on user is a business process monitor (system monitor).

In general, authorization is granted to persons explicitly when a process template is defined or implicitly, for example, when a process instance is started. Above that, special authority is granted to a person playing the role of a business process (system) monitor. A business process monitor has the priviledge to read all objects.

Specified by:
isBusinessProcessMonitor in interface BusinessFlowManagerService
Returns:
boolean - boolean - True states that the logged-on user is a business process monitor. False states that the logged-on user is no business process monitor.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

getClientUISettings

public CustomClientSettings getClientUISettings(java.lang.String identifier)
                                         throws EngineNotAuthorizedException,
                                                EngineWrongKindException,
                                                IdWrongFormatException,
                                                IdWrongTypeException,
                                                ObjectDoesNotExistException,
                                                ServiceNotUniqueException,
                                                UnexpectedFailureException,
                                                java.rmi.RemoteException,
                                                javax.ejb.EJBException
Retrieves client interface settings for the specified process template, process instance, or activity instance using a string representation of the object ID.

Client interface settings allow for the specification of presentations that can be used by the caller to present objects and data to an end user. It is not only possible to display data handled by activities in a specific way but also to specify JSPs that display the properties of process instances and their templates specifically.

Client interface settings can always be retrieved. When they are to be retrieved for a process or activity instance, the caller must have at least reader authority for the process or activity instance.

Specified by:
getClientUISettings in interface BusinessFlowManagerService
Parameters:
identifier - A string representation of either a process template, a process instance, or an activity instance object ID.

Returns:
CustomClientSettings - The customized client interface settings. Returns null if there are no customized client interface settings.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
ServiceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getClientUISettings

public CustomClientSettings getClientUISettings(PTID ptid)
                                         throws EngineNotAuthorizedException,
                                                EngineWrongKindException,
                                                IdWrongFormatException,
                                                ObjectDoesNotExistException,
                                                UnexpectedFailureException,
                                                java.rmi.RemoteException,
                                                javax.ejb.EJBException
Retrieves client interface settings for the specified process template using the process template ID.

Client interface settings allow for the specification of presentations that can be used by the caller to present objects and data to an end user. It is not only possible to display data handled by activities in a specific way but also to specify JSPs that display the properties of process instances and their templates specifically.

The caller must be authorized for the process template.

Specified by:
getClientUISettings in interface BusinessFlowManagerService
Parameters:
ptid - The object ID of the process template.

Returns:
CustomClientSettings - The customized client interface settings. Returns null if there are no customized client interface settings.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getClientUISettings

public CustomClientSettings getClientUISettings(PIID piid)
                                         throws EngineNotAuthorizedException,
                                                EngineWrongKindException,
                                                IdWrongFormatException,
                                                ObjectDoesNotExistException,
                                                UnexpectedFailureException,
                                                java.rmi.RemoteException,
                                                javax.ejb.EJBException
Retrieves client interface settings for the specified process instance using the process instance ID.

Client interface settings allow for the specification of presentations that can be used by the caller to present objects and data to an end user. It is not only possible to display data handled by activities in a specific way but also to specify JSPs that display the properties of process instances and their templates specifically.

Client interface settings can be retrieved in any execution state of the process instance. The caller must have at least reader authority for the process instance.

Specified by:
getClientUISettings in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance.

Returns:
CustomClientSettings - The customized client interface settings. Returns null if there are no customized client interface settings.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getClientUISettings

public CustomClientSettings getClientUISettings(AIID aiid)
                                         throws EngineNotAuthorizedException,
                                                EngineWrongKindException,
                                                IdWrongFormatException,
                                                ObjectDoesNotExistException,
                                                ServiceNotUniqueException,
                                                UnexpectedFailureException,
                                                java.rmi.RemoteException,
                                                javax.ejb.EJBException
Retrieves client interface settings for the specified activity instance using the activity instance ID.

Client interface settings allow for the specification of presentations that can be used by the caller to present objects and data to an end user. It is not only possible to display data handled by activities in a specific way but also to specify JSPs that display the properties of process instances and their templates specifically.

Client interface settings can be retrieved in any execution state of the activity and associated process instance. The caller must have at least reader authority for the activity instance or for the associated process instance.

Specified by:
getClientUISettings in interface BusinessFlowManagerService
Parameters:
aiid - The object ID of the activity instance.

Returns:
CustomClientSettings - The customized client interface settings. Returns null if there are no customized client interface settings.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
IdWrongFormatException
ObjectDoesNotExistException
ServiceNotUniqueException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getClientUISettings

public CustomClientSettings getClientUISettings(java.lang.String vtid,
                                                java.lang.String atid)
                                         throws EngineNotAuthorizedException,
                                                EngineWrongKindException,
                                                IdWrongFormatException,
                                                IdWrongTypeException,
                                                ObjectDoesNotExistException,
                                                UnexpectedFailureException,
                                                java.rmi.RemoteException,
                                                javax.ejb.EJBException
Retrieves client interface settings for the specified service using a string representation of the activity and service object IDs.

Client interface settings allow for the specification of presentations that can be used by the caller to present objects and data to an end user. It is not only possible to display data handled by activities in a specific way but also to specify JSPs that display the properties of process instances and their templates specifically.

Client interface settings can be retrieved in any execution state of the activity and associated process instance. The caller must have at least reader authority for the activity instance or for the associated process instance.

Specified by:
getClientUISettings in interface BusinessFlowManagerService
Parameters:
vtid - A string representation of the activity service template ID. This is used to identify the service whose settings are to be retrieved.
atid - A string representation of the activity template ID. This is used to identify the activity the service belongs to.

Returns:
CustomClientSettings - The customized client interface settings. Returns null if there are no customized client interface settings.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1

getClientUISettings

public CustomClientSettings getClientUISettings(VTID vtid,
                                                ATID atid)
                                         throws EngineNotAuthorizedException,
                                                EngineWrongKindException,
                                                IdWrongFormatException,
                                                ObjectDoesNotExistException,
                                                UnexpectedFailureException,
                                                java.rmi.RemoteException,
                                                javax.ejb.EJBException
Retrieves client interface settings for the specified service using the activity and service object IDs.

Client interface settings allow for the specification of presentations that can be used by the caller to present objects and data to an end user. It is not only possible to display data handled by activities in a specific way but also to specify JSPs that display the properties of process instances and their templates specifically.

Client interface settings can be retrieved in any execution state of the activity and associated process instance. The caller must have at least reader authority for the activity instance or for the associated process instance.

Specified by:
getClientUISettings in interface BusinessFlowManagerService
Parameters:
vtid - The object ID of the activity service template whose settings are to be retrieved.
atid - The object ID of the activity the activity service template belongs to.

Returns:
CustomClientSettings - The customized client interface settings. Returns null if there are no customized client interface settings.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1

getInputClientUISettings

public CustomClientSettings getInputClientUISettings(java.lang.String piid)
                                              throws EngineNotAuthorizedException,
                                                     EngineWrongKindException,
                                                     IdWrongFormatException,
                                                     IdWrongTypeException,
                                                     ObjectDoesNotExistException,
                                                     UnexpectedFailureException,
                                                     java.rmi.RemoteException,
                                                     javax.ejb.EJBException
Retrieves client interface settings for the input message of the specified process instance using a string representation of the process instance ID.

Client interface settings allow for the specification of presentations that can be used by the caller to present objects and data to an end user in a specific way.

Client interface settings can be retrieved in any execution state of the process instance. The caller must have at least reader authority for the process instance.

Specified by:
getInputClientUISettings in interface BusinessFlowManagerService
Parameters:
piid - The string representation of the process instance object ID. This is used to identify the process instance whose input UI settings are to be retrieved.

Returns:
CustomClientSettings - The customized client interface settings of the input message. Returns null if there are no customized client interface settings.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getInputClientUISettings

public CustomClientSettings getInputClientUISettings(PIID piid)
                                              throws EngineNotAuthorizedException,
                                                     EngineWrongKindException,
                                                     IdWrongFormatException,
                                                     ObjectDoesNotExistException,
                                                     UnexpectedFailureException,
                                                     java.rmi.RemoteException,
                                                     javax.ejb.EJBException
Retrieves client interface settings for the input message of the specified process instance using the process instance ID.

Client interface settings allow for the specification of presentations that can be used by the caller to present objects and data to an end user in a specific way.

Client interface settings can be retrieved in any execution state of the process instance. The caller must have at least reader authority for the process instance.

Specified by:
getInputClientUISettings in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance.

Returns:
CustomClientSettings - The customized client interface settings of the input message. Returns null if there are no customized client interface settings.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getOutputClientUISettings

public CustomClientSettings getOutputClientUISettings(java.lang.String piid)
                                               throws EngineNotAuthorizedException,
                                                      EngineWrongKindException,
                                                      IdWrongFormatException,
                                                      IdWrongTypeException,
                                                      ObjectDoesNotExistException,
                                                      UnexpectedFailureException,
                                                      java.rmi.RemoteException,
                                                      javax.ejb.EJBException
Retrieves client interface settings for the output message of the specified process instance using a string representation of the process instance ID.

Client interface settings allow for the specification of presentations that can be used by the caller to present objects and data to an end user in a specific way.

Client interface settings can be retrieved in any execution state of the process instance. The caller must have at least reader authority for the process instance.

Specified by:
getOutputClientUISettings in interface BusinessFlowManagerService
Parameters:
piid - The string representation of the process instance object ID. This is used to identify the process instance whose output UI settings are to be retrieved.

Returns:
CustomClientSettings - The customized client interface settings of the output message. Returns null if there are no customized client interface settings.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getOutputClientUISettings

public CustomClientSettings getOutputClientUISettings(PIID piid)
                                               throws EngineNotAuthorizedException,
                                                      EngineWrongKindException,
                                                      IdWrongFormatException,
                                                      ObjectDoesNotExistException,
                                                      UnexpectedFailureException,
                                                      java.rmi.RemoteException,
                                                      javax.ejb.EJBException
Retrieves client interface settings for the output message of the specified process instance using the process instance ID.

Client interface settings allow for the specification of presentations that can be used by the caller to present objects and data to an end user in a specific way.

Client interface settings can be retrieved in any execution state of the process instance. The caller must have at least reader authority for the process instance.

Specified by:
getOutputClientUISettings in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance.

Returns:
CustomClientSettings - The customized client interface settings of the output message. Returns null if there are no customized client interface settings.

Throws:
EngineNotAuthorizedException
EngineWrongKindException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
5.1 - FDML related exceptions removed

getActiveEventHandlers

public EventHandlerTemplateData[] getActiveEventHandlers(java.lang.String piid)
                                                  throws EngineNotAuthorizedException,
                                                         IdWrongFormatException,
                                                         IdWrongTypeException,
                                                         ObjectDoesNotExistException,
                                                         UnexpectedFailureException,
                                                         java.rmi.RemoteException,
                                                         javax.ejb.EJBException
Retrieves the active event handlers of the specified process instance using a string representation of the process instance object ID.

The caller must have at least reader authority for the process instance.

Specified by:
getActiveEventHandlers in interface BusinessFlowManagerService
Parameters:
piid - The String representation of the object ID of the process instance.

Returns:
EventHandlerTemplateData[] - An array of qualifying event handler templates. If no templates qualify, an empty array is returned. Refer to EventHandlerTemplateData to view the event handler template properties.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0

getActiveEventHandlers

public EventHandlerTemplateData[] getActiveEventHandlers(PIID piid)
                                                  throws EngineNotAuthorizedException,
                                                         IdWrongFormatException,
                                                         ObjectDoesNotExistException,
                                                         UnexpectedFailureException,
                                                         java.rmi.RemoteException,
                                                         javax.ejb.EJBException
Retrieves the active event handlers of the specified process instance using the process instance ID.

The caller must have at least reader authority for the process instance.

Specified by:
getActiveEventHandlers in interface BusinessFlowManagerService
Parameters:
piid - The object ID of the process instance.

Returns:
EventHandlerTemplateData[] - An array of qualifying event handler templates. If no templates qualify, an empty array is returned. Refer to EventHandlerTemplateData to view the event handler template properties.

Throws:
EngineNotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.rmi.RemoteException
javax.ejb.EJBException
Since:
6.0