com.ibm.bpe.api
Interface BusinessProcessService

All Known Subinterfaces:
BusinessProcess, LocalBusinessProcess, LocalBusinessProcessService

public interface BusinessProcessService

BusinessProcessService defines the business functions that can be called by a local or remote client.


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 processTemplateName, ClientObjectWrapper inputMessage, java.util.Map variables)
          Deprecated. 

 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 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 BPEL 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 contained within a BPEL process 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(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, or activity instance using a string representation of the process template ID, the process instance ID, or the activity instance 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 createWorkItem(AIID aiid, int assignmentReason, java.lang.String userID)
          Creates a work item for BPEL 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 BPEL 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 BPEL 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 deleteWorkItem(AIID aiid, int assignmentReason, java.lang.String userID)
          Deletes the specified work item for the specified BPEL activity instance.
 void deleteWorkItem(PIID piid, int assignmentReason, java.lang.String userID)
          Deletes the specified work item for the specified BPEL 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 BPEL process or activity instance ID.
 void deleteWorkList(java.lang.String workListName)
          Deletes the specified worklist.
 QueryResultSet executeWorkList(java.lang.String workListName)
          Executes the query defined by the worklist and returns the qualifying object properties.
 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.
 ActivityInstanceData getActivityInstance(AIID aiid)
          Retrieves the specified activity instance using the activity instance ID.
 ActivityInstanceData getActivityInstance(PIID piid, java.lang.String activityTemplateName)
          Deprecated. 

 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)
          Deprecated. 

 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 or block instance using the process or block 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 or block instance using a string representation of the process or block 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.
 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.lang.String getCustomAttribute(AIID aiid, java.lang.String attributeName)
          Deprecated. For Bpel processes replaced by getCustomProperty(AIID,String).

 java.lang.String getCustomAttribute(PIID piid, java.lang.String attributeName)
          Deprecated. For Bpel processes replaced by getCustomProperty(PIID,String).

 java.lang.String getCustomAttribute(PTID ptid, java.lang.String attributeName)
          Deprecated. For Bpel processes replaced by getCustomProperty(PTID,String).

 java.lang.String getCustomAttribute(java.lang.String identifier, java.lang.String attributeName)
          Deprecated. For Bpel processes replaced by getCustomProperty(String,String).

 java.lang.String getCustomProperty(AIID aiid, java.lang.String propertyName)
          For BPEL processes, 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)
          For BPEL processes, 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)
          For BPEL processes, 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)
          For BPEL processes, 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 getEventNames(PIID piid)
          Deprecated. 

 java.util.List getEventNames(PTID ptid)
          Deprecated. 

 java.util.List getEventNames(java.lang.String identifier)
          Deprecated. 

 ClientObjectWrapper getFaultMessage(AIID aiid)
          For a BPEL process, retrieves the fault message of the specified activity instance using the activity instance ID.
 ClientObjectWrapper getFaultMessage(AIID aiid, java.lang.String faultTerminalName)
          Deprecated. The fault message of a BPEL process can be read without specifying the fault name - see getFaultMessage(AIID).

 ClientObjectWrapper getFaultMessage(PIID piid)
          For a BPEL process, retrieves the fault message of the specified process instance using the process instance ID.
 ClientObjectWrapper getFaultMessage(PIID piid, java.lang.String faultTerminalName)
          Deprecated. The fault message of a BPEL process can be read without specifying the fault name - see getFaultMessage(PIID).

 ClientObjectWrapper getFaultMessage(java.lang.String identifier)
          For a BPEL process, retrieves the fault message of the specified process or activity instance using a string representation of the process or activity instance ID.
 ClientObjectWrapper getFaultMessage(java.lang.String identifier, java.lang.String faultTerminalName)
          Deprecated. The fault message of a BPEL process can be read without specifying the fault name - see getFaultMessage(String).

 java.util.List getFaultNames(AIID aiid)
          For a BPEL process, retrieves the fault names defined for the specified activity instance using the activity instance ID.
 java.util.List getFaultNames(java.lang.String aiid)
          For a BPEL process, retrieves the fault names defined for the specified activity instance using a string representation of the activity instance ID.
 java.util.List getFaultTerminalNames(AIID aiid)
          Deprecated. For BPEL processes replaced by getFaultNames(AIID).

 java.util.List getFaultTerminalNames(PIID piid)
          Deprecated. No longer needed for BPEL processes. A fault message can be read without specifying the fault name - see getFaultMessage(PIID).

 java.util.List getFaultTerminalNames(PTID ptid)
          Deprecated. 

 java.util.List getFaultTerminalNames(java.lang.String identifier)
          Deprecated. For BPEL processes replaced by getFaultNames(String).

 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 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 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(AIID aiid, java.lang.String outputTerminalName)
          Deprecated. For BPEL processes replaced by getOutputMessage(AIID).

 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.
 ClientObjectWrapper getOutputMessage(java.lang.String identifier, java.lang.String outputTerminalName)
          Deprecated. For BPEL processes replaced by getOutputMessage(String).

 java.util.List getOutputTerminalNames(AIID aiid)
          Deprecated. 

 java.util.List getOutputTerminalNames(java.lang.String aiid)
          Deprecated. 

 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 BPEL 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 BPEL process instance from the specified process template using a string representation of the process template ID.
 ClientObjectWrapper getUISettings(AIID aiid, java.lang.String typeSystem)
          Deprecated. 

 ClientObjectWrapper getUISettings(PIID piid, java.lang.String typeSystem)
          Deprecated. 

 ClientObjectWrapper getUISettings(PTID ptid, java.lang.String typeSystem)
          Deprecated. 

 ClientObjectWrapper getUISettings(java.lang.String identifier, java.lang.String typeSystem)
          Deprecated. 

 UserInput[] getUserInput(AIID aiid)
          Deprecated. 

 UserInput[] getUserInput(java.lang.String aiid)
          Deprecated. 

 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 piid, java.lang.String variableName)
          Retrieves the specified variable of the specified process instance using a string representation of the process instance ID.
 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)
          Retrieves the specified worklist definition.
 int[] getWorkListActions()
          Returns the actions that can be called by the logged-on user related to worklists.
 java.lang.String[] getWorkListNames()
          Retrieves the names of worklists persistently stored in the database.
 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, ClientObjectWrapper inputMessage, java.util.Map variables)
          Deprecated. 

 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 processTemplateName, java.lang.String processInstanceName, ClientObjectWrapper inputMessage, java.util.Map variables)
          Deprecated. 

 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.
 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)
          Creates a worklist and persistently stores it 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.
 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 refreshStaffQuery()
          Deprecated.  
 void refreshStaffQuery(AIID aiid)
          Deprecated.  
 void refreshStaffQuery(PIID piid)
          Deprecated.  
 void refreshStaffQuery(PTID ptid)
          Deprecated.  
 void refreshStaffQuery(java.lang.String identifier)
          Deprecated.  
 void sendEvent(PIID piid, java.lang.String eventName, ClientObjectWrapper inputMessage)
          Deprecated. For BPEL processes replaced by sendMessage(java.lang.String, java.lang.String, com.ibm.bpe.api.ClientObjectWrapper).

 void sendEvent(java.lang.String identifier, java.lang.String eventName, ClientObjectWrapper inputMessage)
          Deprecated. For BPEL processes replaced by sendMessage(java.lang.String, java.lang.String, com.ibm.bpe.api.ClientObjectWrapper).

 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(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 setCustomAttribute(AIID aiid, java.lang.String attributeName, java.lang.String attributeValue)
          Deprecated. For Bpel processes replaced by setCustomProperty(AIID,String,String).

 void setCustomAttribute(PIID piid, java.lang.String attributeName, java.lang.String attributeValue)
          Deprecated. For Bpel processes replaced by setCustomProperty(PIID,String,String).

 void setCustomAttribute(java.lang.String identifier, java.lang.String attributeName, java.lang.String attributeValue)
          Deprecated. For Bpel processes replaced by setCustomProperty(String,String,String).

 void setCustomProperty(AIID aiid, java.lang.String propertyName, java.lang.String propertyValue)
          For BPEL processes, 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)
          For BPEL processes, 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)
          For BPEL processes, 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(AIID aiid, java.lang.String outputTerminalName, ClientObjectWrapper outputMessage)
          Deprecated. For BPEL processes replaced by setOutputMessage(AIID,ClientObjectWrapper) or setVariable.

 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 setOutputMessage(java.lang.String aiid, java.lang.String outputTerminalName, ClientObjectWrapper outputMessage)
          Deprecated. For BPEL processes replaced by setOutputMessage(String,ClientObjectWrapper) or setVariable.

 void setUserInput(AIID aiid, UserInput[] userInput)
          Deprecated. 

 void setUserInput(java.lang.String aiid, UserInput[] userInput)
          Deprecated. 

 void setVariable(PIID piid, java.lang.String variableName, ClientObjectWrapper message)
          For a BPEL process, sets the specified variable using the variable name and the associated process instance ID.
 void setVariable(java.lang.String piid, java.lang.String variableName, ClientObjectWrapper message)
          For a BPEL process, sets the specified variable using the variable name and a string representation of the associated process instance ID.
 void transferWorkItem(AIID aiid, int assignmentReason, java.lang.String fromUserID, java.lang.String toUserID)
          Transfers a work item for the specified BPEL 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 BPEL 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 of a BPEL process to the specified user using a string representation of either the process or activity instance ID.
 

Method Detail

queryProcessTemplates

public ProcessTemplateData[] queryProcessTemplates(java.lang.String whereClause,
                                                   java.lang.String orderByClause,
                                                   java.lang.Integer threshold,
                                                   java.util.TimeZone timeZone)
                                            throws java.rmi.RemoteException,
                                                   EngineAuthorizationPluginException,
                                                   EngineCannotInitializePluginException,
                                                   IdWrongFormatException,
                                                   IdWrongTypeException,
                                                   InvalidLengthException,
                                                   ObjectDoesNotExistException,
                                                   QueryInvalidOperandException,
                                                   QueryInvalidTimestampException,
                                                   QueryUndefinedParameterException,
                                                   QueryUnknownColumnException,
                                                   QueryUnknownOperatorException,
                                                   QueryUnknownTableException,
                                                   javax.ejb.EJBException,
                                                   UnexpectedFailureException
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. BPEL 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.

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".

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.

threshold - Specifies the maximum number of process templates to be returned. 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:
java.rmi.RemoteException
EngineAuthorizationPluginException
EngineCannotInitializePluginException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
QueryInvalidOperandException
QueryInvalidTimestampException
QueryUndefinedParameterException
QueryUnknownColumnException
QueryUnknownOperatorException
QueryUnknownTableException
javax.ejb.EJBException
UnexpectedFailureException
Since:
5.0

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 java.rmi.RemoteException,
                            javax.ejb.EJBException,
                            WorkItemManagerException,
                            UnexpectedFailureException
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.

Parameters:
selectClause - Describes the query result, that is, represents 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(), COUNT(), 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.

The QueryResultSet produced by selecting the specified properties only contains columns in the same order as specified in the selectClause.

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".

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.

threshold - The maximum number of query result set tuples to be returned. 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:
java.rmi.RemoteException
javax.ejb.EJBException
WorkItemManagerException
UnexpectedFailureException
Since:
5.0

getActivityInstance

public ActivityInstanceData getActivityInstance(java.lang.String aiid)
                                         throws java.rmi.RemoteException,
                                                javax.ejb.EJBException,
                                                EngineCannotInitializePluginException,
                                                EngineDataPluginException,
                                                EngineNotAuthorizedException,
                                                EngineWrongKindException,
                                                EngineWrongStateException,
                                                IdWrongFormatException,
                                                IdWrongTypeException,
                                                InvalidLengthException,
                                                ObjectDoesNotExistException,
                                                UserInputInitException,
                                                UnexpectedFailureException
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.

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. If the specified activity instance is not found, null is returned. Refer to ActivityInstanceData to view the activity instance properties.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UserInputInitException
UnexpectedFailureException
Since:
5.0

getActivityInstance

public ActivityInstanceData getActivityInstance(AIID aiid)
                                         throws java.rmi.RemoteException,
                                                javax.ejb.EJBException,
                                                EngineCannotInitializePluginException,
                                                EngineDataPluginException,
                                                EngineNotAuthorizedException,
                                                EngineWrongKindException,
                                                EngineWrongStateException,
                                                IdWrongFormatException,
                                                IdWrongTypeException,
                                                InvalidLengthException,
                                                ObjectDoesNotExistException,
                                                UserInputInitException,
                                                UnexpectedFailureException
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.

Parameters:
aiid - The object ID of the activity instance to be retrieved.

Returns:
ActivityInstanceData - The activity instance. If the specified activity instance is not found, null is returned. Refer to ActivityInstanceData to view the activity instance properties.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UserInputInitException
UnexpectedFailureException
Since:
5.1

getActivityInstance

public ActivityInstanceData getActivityInstance(java.lang.String piid,
                                                java.lang.String activityTemplateName)
                                         throws java.rmi.RemoteException,
                                                javax.ejb.EJBException,
                                                ActivityNameNotUniqueException,
                                                EngineCannotInitializePluginException,
                                                EngineDataPluginException,
                                                EngineNotAuthorizedException,
                                                EngineParameterNullException,
                                                EngineWrongKindException,
                                                EngineWrongStateException,
                                                IdWrongFormatException,
                                                IdWrongTypeException,
                                                InvalidLengthException,
                                                ObjectDoesNotExistException,
                                                UserInputInitException,
                                                UnexpectedFailureException
Deprecated. 

Retrieves the specified activity instance using a string representation of the process or block instance ID and the activity 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.

Parameters:
piid - The String representation of the object ID of the containing process or schema 5.0 block instance.
activityTemplateName - The name of the activity template that describes the activity instance to be retrieved.

Returns:
ActivityInstanceData - The activity instance retrieved. If the specified activity instance is not found, null is returned. Refer to ActivityInstanceData to view the activity instance properties.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
ActivityNameNotUniqueException
EngineCannotInitializePluginException
EngineDataPluginException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UserInputInitException
UnexpectedFailureException
Since:
5.1

getActivityInstance

public ActivityInstanceData getActivityInstance(PIID piid,
                                                java.lang.String activityTemplateName)
                                         throws java.rmi.RemoteException,
                                                javax.ejb.EJBException,
                                                ActivityNameNotUniqueException,
                                                EngineCannotInitializePluginException,
                                                EngineDataPluginException,
                                                EngineNotAuthorizedException,
                                                EngineParameterNullException,
                                                EngineWrongKindException,
                                                EngineWrongStateException,
                                                IdWrongFormatException,
                                                IdWrongTypeException,
                                                InvalidLengthException,
                                                ObjectDoesNotExistException,
                                                UserInputInitException,
                                                UnexpectedFailureException
Deprecated. 

Retrieves the specified activity instance using the process or block instance ID and the activity 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.

Parameters:
piid - The object ID of the process instance or schema 5.0 block instance.
activityTemplateName - The name of the activity template that describes the activity instance to be retrieved.

Returns:
ActivityInstanceData - The activity instance retrieved. If the specified activity instance is not found, null is returned. Refer to ActivityInstanceData to view the activity instance properties.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
ActivityNameNotUniqueException
EngineCannotInitializePluginException
EngineDataPluginException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UserInputInitException
UnexpectedFailureException
Since:
5.1

getProcessTemplate

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

The caller must be authorized for the process template.

Parameters:
ptid - The object ID of the process template to be retrieved.

Returns:
ProcessTemplateData - The process template. If the specified process template is not found, null is returned. Refer to ProcessTemplateData to view the process template properties.

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

getProcessTemplate

public ProcessTemplateData getProcessTemplate(java.lang.String identifier)
                                       throws java.rmi.RemoteException,
                                              javax.ejb.EJBException,
                                              EngineCannotInitializePluginException,
                                              EngineNotAuthorizedException,
                                              EngineParameterNullException,
                                              IdWrongTypeException,
                                              InvalidLengthException,
                                              ObjectDoesNotExistException,
                                              UnexpectedFailureException
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 template with this name, then the currently valid template is returned.

The caller must be authorized for the process template.

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. If the specified process template is not found, null is returned. Refer to ProcessTemplateData to view the process template properties.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineNotAuthorizedException
EngineParameterNullException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getProcessInstance

public ProcessInstanceData getProcessInstance(java.lang.String identifier)
                                       throws java.rmi.RemoteException,
                                              javax.ejb.EJBException,
                                              EngineCannotInitializePluginException,
                                              EngineNotAuthorizedException,
                                              EngineParameterNullException,
                                              EngineWrongStateException,
                                              IdWrongTypeException,
                                              InvalidLengthException,
                                              ObjectDoesNotExistException,
                                              UnexpectedFailureException
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.

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. If the specified process instance is not found, null is returned. Refer to ProcessInstanceData to view the process instance properties.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongStateException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getProcessInstance

public ProcessInstanceData getProcessInstance(PIID piid)
                                       throws java.rmi.RemoteException,
                                              javax.ejb.EJBException,
                                              EngineCannotInitializePluginException,
                                              EngineNotAuthorizedException,
                                              EngineWrongStateException,
                                              IdWrongFormatException,
                                              IdWrongTypeException,
                                              InvalidLengthException,
                                              ObjectDoesNotExistException,
                                              UnexpectedFailureException
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.

Parameters:
piid - The object ID of the process instance to be retrieved.

Returns:
ProcessInstanceData - The process instance. If the specified process instance is not found, null is returned. Refer to ProcessInstanceData to view the process instance properties.

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

getEventNames

public java.util.List getEventNames(java.lang.String identifier)
                             throws java.rmi.RemoteException,
                                    javax.ejb.EJBException,
                                    IdWrongTypeException,
                                    IdWrongFormatException,
                                    UnexpectedFailureException
Deprecated. 

Retrieves the receive event names of the specified process template or process instance using a string representation of the process template or instance ID.

Receive event names can be retrieved in any execution state of the process instance. The caller must be authorized to access the process template respectively must have at least reader authority for the process instance.

For a schema 5.0 process migrated to BPEL, this method returns names of pick or receive activities that potentially wait for a message to be sent.

Parameters:
identifier - The string representation of the process template or the process instance object ID. This is used to identify the process template or process instance whose receive event names are to be retrieved.

Returns:
List - A list of receive event names.

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

getEventNames

public java.util.List getEventNames(PTID ptid)
                             throws java.rmi.RemoteException,
                                    javax.ejb.EJBException,
                                    IdWrongFormatException,
                                    UnexpectedFailureException
Deprecated. 

Retrieves the receive event names of the specified process template using the process template ID.

The caller must be authorized to access the process template.

For a schema 5.0 process migrated to BPEL, this method returns names of pick or receive activities that potentially wait for a message to be sent.

Parameters:
ptid - The object ID of the process template whose receive event names are to be retrieved.

Returns:
List - A list of receive event names.

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

getEventNames

public java.util.List getEventNames(PIID piid)
                             throws java.rmi.RemoteException,
                                    javax.ejb.EJBException,
                                    IdWrongFormatException,
                                    UnexpectedFailureException
Deprecated. 

Retrieves the receive event names of the specified process instance using the process instance ID.

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

For a schema 5.0 process migrated to BPEL, this method returns names of pick or receive activities that potentially wait for a message to be sent.

Parameters:
piid - The object ID of the process instance whose receive event names are to be retrieved.

Returns:
List - A list of receive event names.

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

getInputMessage

public ClientObjectWrapper getInputMessage(java.lang.String identifier)
                                    throws java.rmi.RemoteException,
                                           javax.ejb.EJBException,
                                           DataHandlingException,
                                           EngineCannotInitializePluginException,
                                           EngineDataPluginException,
                                           EngineNotAuthorizedException,
                                           EngineWrongStateException,
                                           EngineWrongKindException,
                                           IdWrongFormatException,
                                           IdWrongTypeException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException
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. For a schema 5.0 process, the input message can be retrieved in any execution state of the activity instance. For a BPEL process, the input message can be retrieved in the claimed, expired, failed, finished, terminated, ready, or stopped execution states 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
DataHandlingException
EngineCannotInitializePluginException
EngineDataPluginException
EngineNotAuthorizedException
EngineWrongStateException
EngineWrongKindException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getInputMessage

public ClientObjectWrapper getInputMessage(PIID piid)
                                    throws java.rmi.RemoteException,
                                           javax.ejb.EJBException,
                                           EngineCannotInitializePluginException,
                                           EngineDataPluginException,
                                           EngineNotAuthorizedException,
                                           EngineWrongKindException,
                                           EngineWrongStateException,
                                           IdWrongFormatException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException
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.

Parameters:
piid - The object ID of the process instance whose input message is to be retrieved.

Returns:
ClientObjectWrapper - The input message.

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

getInputMessage

public ClientObjectWrapper getInputMessage(AIID aiid)
                                    throws java.rmi.RemoteException,
                                           javax.ejb.EJBException,
                                           DataHandlingException,
                                           EngineCannotInitializePluginException,
                                           EngineDataPluginException,
                                           EngineNotAuthorizedException,
                                           EngineWrongStateException,
                                           EngineWrongKindException,
                                           IdWrongFormatException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException
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. For a schema 5.0 process, the input message can be retrieved in any execution state of the activity instance. For a BPEL process, the input message can be retrieved in the claimed, expired, failed, finished, terminated, ready, or stopped execution states 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.

Parameters:
aiid - The object ID of the activity instance whose input message is to be retrieved.

Returns:
ClientObjectWrapper - The input message.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
DataHandlingException
EngineCannotInitializePluginException
EngineDataPluginException
EngineNotAuthorizedException
EngineWrongStateException
EngineWrongKindException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.0

getOutputTerminalNames

public java.util.List getOutputTerminalNames(java.lang.String aiid)
                                      throws java.rmi.RemoteException,
                                             javax.ejb.EJBException,
                                             IdWrongTypeException,
                                             IdWrongFormatException,
                                             UnexpectedFailureException
Deprecated. 

Retrieves the output terminal names of the specified activity instance using a string representation of the activity instance ID.

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

For a schema 5.0 process migrated to BPEL, this method returns the names of variables that are said to be updated by the activity.

Parameters:
aiid - A string representation of the activity instance object ID. This is used to identify the activity instance whose output terminal names are to be retrieved.

Returns:
List - A list of output terminal names.

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

getOutputTerminalNames

public java.util.List getOutputTerminalNames(AIID aiid)
                                      throws java.rmi.RemoteException,
                                             javax.ejb.EJBException,
                                             IdWrongFormatException,
                                             UnexpectedFailureException
Deprecated. 

Retrieves the output terminal names of the specified activity instance using the activity instance ID.

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

For a schema 5.0 process migrated to BPEL, this method returns the names of variables that are said to be updated by the activity.

Parameters:
aiid - The object ID of the activity instance whose output terminal names are to be retrieved.

Returns:
List - A list of output terminal names.

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

getOutputMessage

public ClientObjectWrapper getOutputMessage(java.lang.String identifier)
                                     throws java.rmi.RemoteException,
                                            javax.ejb.EJBException,
                                            DataHandlingException,
                                            EngineCannotInitializePluginException,
                                            EngineDataPluginException,
                                            EngineNotAuthorizedException,
                                            EngineWrongKindException,
                                            EngineWrongStateException,
                                            IdWrongFormatException,
                                            IdWrongTypeException,
                                            ObjectDoesNotExistException,
                                            UnexpectedFailureException
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. For a schema 5.0 process, the output message can be retrieved in any execution state of the activity instance. For a BPEL process, the output message can be retrieved in the claimed, expired, failed, finished, terminated, ready, or stopped execution states 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
DataHandlingException
EngineCannotInitializePluginException
EngineDataPluginException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getOutputMessage

public ClientObjectWrapper getOutputMessage(PIID piid)
                                     throws java.rmi.RemoteException,
                                            javax.ejb.EJBException,
                                            EngineCannotInitializePluginException,
                                            EngineDataPluginException,
                                            EngineNotAuthorizedException,
                                            EngineWrongKindException,
                                            EngineWrongStateException,
                                            IdWrongFormatException,
                                            ObjectDoesNotExistException,
                                            UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getOutputMessage

public ClientObjectWrapper getOutputMessage(AIID aiid)
                                     throws java.rmi.RemoteException,
                                            javax.ejb.EJBException,
                                            DataHandlingException,
                                            EngineCannotInitializePluginException,
                                            EngineDataPluginException,
                                            EngineNotAuthorizedException,
                                            EngineWrongKindException,
                                            EngineWrongStateException,
                                            IdWrongFormatException,
                                            ObjectDoesNotExistException,
                                            UnexpectedFailureException
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. For a schema 5.0 process, the output message can be retrieved in any execution state of the activity instance. For a BPEL process, the output message can be retrieved in the claimed, expired, failed, finished, terminated, ready, or stopped execution states 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
DataHandlingException
EngineCannotInitializePluginException
EngineDataPluginException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getOutputMessage

public ClientObjectWrapper getOutputMessage(java.lang.String identifier,
                                            java.lang.String outputTerminalName)
                                     throws java.rmi.RemoteException,
                                            javax.ejb.EJBException,
                                            EngineCannotInitializePluginException,
                                            EngineNotAuthorizedException,
                                            EngineParameterNullException,
                                            EngineDataPluginException,
                                            EngineWrongStateException,
                                            EngineWrongKindException,
                                            DataHandlingException,
                                            IdWrongFormatException,
                                            IdWrongTypeException,
                                            ObjectDoesNotExistException,
                                            UnexpectedFailureException
Deprecated. For BPEL processes replaced by getOutputMessage(String).

Retrieves the specified output message of the specified activity instance using a string representation of the ID.

An output message can be retrieved in any execution state of the associated process instance. For a schema 5.0 process, the output message can be retrieved in any execution state of the activity instance. For a BPEL process, the output message can be retrieved in the claimed, expired, failed, finished, terminated, ready, or stopped execution states 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.

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.

outputTerminalName - The name of the output message or variable to be retrieved.

Returns:
ClientObjectWrapper - The output message. If the specified output message has not yet been created or when the specified variable is not updated by the activity, a empty client object wrapper is returned.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineNotAuthorizedException
EngineParameterNullException
EngineDataPluginException
EngineWrongStateException
EngineWrongKindException
DataHandlingException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getOutputMessage

public ClientObjectWrapper getOutputMessage(AIID aiid,
                                            java.lang.String outputTerminalName)
                                     throws java.rmi.RemoteException,
                                            javax.ejb.EJBException,
                                            EngineCannotInitializePluginException,
                                            EngineNotAuthorizedException,
                                            EngineParameterNullException,
                                            EngineDataPluginException,
                                            EngineWrongStateException,
                                            EngineWrongKindException,
                                            DataHandlingException,
                                            IdWrongFormatException,
                                            ObjectDoesNotExistException,
                                            UnexpectedFailureException
Deprecated. For BPEL processes replaced by getOutputMessage(AIID).

Retrieves the specified 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. For a schema 5.0 process, the output message can be retrieved in any execution state of the activity instance. For a BPEL process, the output message can be retrieved in the claimed, expired, failed, finished, terminated, ready, or stopped execution states 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.

Parameters:
aiid - The object ID of the activity instance whose output message is to be retrieved.
outputTerminalName - The name of the output message or variable to be retrieved.

Returns:
ClientObjectWrapper The output message. If the specified output message has not yet been created or when the specified variable is not updated by the activity, a empty client object wrapper is returned.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineNotAuthorizedException
EngineParameterNullException
EngineDataPluginException
EngineWrongStateException
EngineWrongKindException
DataHandlingException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

setOutputMessage

public void setOutputMessage(java.lang.String aiid,
                             ClientObjectWrapper outputMessage)
                      throws java.rmi.RemoteException,
                             javax.ejb.EJBException,
                             EngineCannotInitializePluginException,
                             EngineDataPluginException,
                             EngineNotAuthorizedException,
                             EngineParameterNullException,
                             EngineWrongKindException,
                             EngineWrongMessageTypeException,
                             EngineWrongStateException,
                             IdWrongFormatException,
                             IdWrongTypeException,
                             ObjectDoesNotExistException,
                             UnexpectedFailureException
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. If a schema 5.0 activity has more than one output terminal, specify the output terminal name. Otherwise the first output terminal read by the engine is set.

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.

For a BPEL process, the activity must be a staff activity. To repair variables used by a stopped invoke or script activity, refer to setVariable.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.0

setOutputMessage

public void setOutputMessage(AIID aiid,
                             ClientObjectWrapper outputMessage)
                      throws java.rmi.RemoteException,
                             javax.ejb.EJBException,
                             EngineCannotInitializePluginException,
                             EngineDataPluginException,
                             EngineNotAuthorizedException,
                             EngineParameterNullException,
                             EngineWrongKindException,
                             EngineWrongMessageTypeException,
                             EngineWrongStateException,
                             IdWrongFormatException,
                             ObjectDoesNotExistException,
                             UnexpectedFailureException
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. If a schema 5.0 activity has more than one output terminal, specify the output terminal name. Otherwise the first output terminal read by the engine is set.

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.

For a BPEL process, the activity must be a staff activity. To repair variables used by a stopped invoke or script activity, refer to setVariable.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

setOutputMessage

public void setOutputMessage(java.lang.String aiid,
                             java.lang.String outputTerminalName,
                             ClientObjectWrapper outputMessage)
                      throws java.rmi.RemoteException,
                             javax.ejb.EJBException,
                             EngineCannotInitializePluginException,
                             EngineDataPluginException,
                             EngineInvalidFaultTerminalException,
                             EngineNotAuthorizedException,
                             EngineParameterNullException,
                             EngineWrongKindException,
                             EngineWrongMessageTypeException,
                             EngineWrongStateException,
                             IdWrongFormatException,
                             IdWrongTypeException,
                             ObjectDoesNotExistException,
                             UnexpectedFailureException
Deprecated. For BPEL processes replaced by setOutputMessage(String,ClientObjectWrapper) or setVariable.

Stores the specified 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.

For a BPEL process, the activity must be a staff activity. To repair variables used by a stopped invoke or script activity, refer to setVariable.

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.
outputTerminalName - The name of the output terminal to be set.
outputMessage - The output message. The object wrapped by the ClientObjectWrapper must be serializable.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineInvalidFaultTerminalException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

setOutputMessage

public void setOutputMessage(AIID aiid,
                             java.lang.String outputTerminalName,
                             ClientObjectWrapper outputMessage)
                      throws java.rmi.RemoteException,
                             javax.ejb.EJBException,
                             EngineCannotInitializePluginException,
                             EngineDataPluginException,
                             EngineInvalidFaultTerminalException,
                             EngineNotAuthorizedException,
                             EngineParameterNullException,
                             EngineWrongKindException,
                             EngineWrongMessageTypeException,
                             EngineWrongStateException,
                             IdWrongFormatException,
                             ObjectDoesNotExistException,
                             UnexpectedFailureException
Deprecated. For BPEL processes replaced by setOutputMessage(AIID,ClientObjectWrapper) or setVariable.

Stores the specified 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.

For a BPEL process, the activity must be a staff activity. To repair variables used by a stopped invoke or script activity, refer to setVariable.

Parameters:
aiid - The object ID of the activity instance whose output message is to be set.
outputTerminalName - The name of the output terminal to be set.
outputMessage - The output message. The object wrapped by the ClientObjectWrapper must be serializable.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineInvalidFaultTerminalException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getFaultNames

public java.util.List getFaultNames(java.lang.String aiid)
                             throws java.rmi.RemoteException,
                                    javax.ejb.EJBException,
                                    EngineNotAuthorizedException,
                                    EngineWrongKindException,
                                    EngineWrongStateException,
                                    IdWrongFormatException,
                                    IdWrongTypeException,
                                    MethodNotApplicableException,
                                    ObjectDoesNotExistException,
                                    UnexpectedFailureException
For a BPEL process, 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
MethodNotApplicableException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getFaultNames

public java.util.List getFaultNames(AIID aiid)
                             throws java.rmi.RemoteException,
                                    javax.ejb.EJBException,
                                    EngineNotAuthorizedException,
                                    EngineWrongKindException,
                                    EngineWrongStateException,
                                    IdWrongFormatException,
                                    MethodNotApplicableException,
                                    ObjectDoesNotExistException,
                                    UnexpectedFailureException
For a BPEL process, 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
MethodNotApplicableException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getFaultMessage

public ClientObjectWrapper getFaultMessage(java.lang.String identifier)
                                    throws java.rmi.RemoteException,
                                           javax.ejb.EJBException,
                                           DataHandlingException,
                                           EngineNotAuthorizedException,
                                           EngineWrongKindException,
                                           EngineWrongStateException,
                                           IdWrongFormatException,
                                           IdWrongTypeException,
                                           MethodNotApplicableException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException
For a BPEL process, 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.

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

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:
java.rmi.RemoteException
javax.ejb.EJBException
DataHandlingException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
MethodNotApplicableException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getFaultMessage

public ClientObjectWrapper getFaultMessage(PIID piid)
                                    throws java.rmi.RemoteException,
                                           javax.ejb.EJBException,
                                           EngineNotAuthorizedException,
                                           EngineWrongKindException,
                                           EngineWrongStateException,
                                           IdWrongFormatException,
                                           MethodNotApplicableException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException
For a BPEL process, 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
MethodNotApplicableException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getFaultMessage

public ClientObjectWrapper getFaultMessage(AIID aiid)
                                    throws java.rmi.RemoteException,
                                           javax.ejb.EJBException,
                                           DataHandlingException,
                                           EngineNotAuthorizedException,
                                           EngineWrongKindException,
                                           EngineWrongStateException,
                                           IdWrongFormatException,
                                           MethodNotApplicableException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException
For a BPEL process, 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.

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

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:
java.rmi.RemoteException
javax.ejb.EJBException
DataHandlingException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
MethodNotApplicableException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getFaultTerminalNames

public java.util.List getFaultTerminalNames(java.lang.String identifier)
                                     throws java.rmi.RemoteException,
                                            javax.ejb.EJBException,
                                            EngineNotAuthorizedException,
                                            EngineWrongKindException,
                                            EngineWrongStateException,
                                            IdWrongFormatException,
                                            IdWrongTypeException,
                                            ObjectDoesNotExistException,
                                            UnexpectedFailureException
Deprecated. For BPEL processes replaced by getFaultNames(String).

Retrieves the fault terminal names of the specified process template or process or activity instance using a string representation of the process template, process instance, or activity instance ID.

Fault terminal names can always be retrieved for process templates. They 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.

Note: An instance of a schema 5.0 process migrated to BPEL, returns the name of the actually thrown fault. A BPEL process template returns the names of all faults defined by reply activities. A BPEL process activity returns the names of faults of staff and stopped invoke activities.

Parameters:
identifier - A string representation of the process template, process instance, or activity instance object ID. This is used to identify the process template, process instance, or activity instance for which fault terminal names are to be retrieved.

Returns:
List - A list of fault terminal names.

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

getFaultTerminalNames

public java.util.List getFaultTerminalNames(PTID ptid)
                                     throws java.rmi.RemoteException,
                                            javax.ejb.EJBException,
                                            IdWrongFormatException,
                                            UnexpectedFailureException
Deprecated. 

Retrieves the fault terminal names of the specified process template using the process template ID.

Fault terminal names can always be retrieved for process templates.

Parameters:
ptid - The object ID of the process template for which the fault terminal names are to be retrieved.

Note: A BPEL process template returns the names of all faults defined by reply activities.

Returns:
List - A list of fault terminal names. If there are no fault terminals, an empty list is returned.

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

getFaultTerminalNames

public java.util.List getFaultTerminalNames(PIID piid)
                                     throws java.rmi.RemoteException,
                                            javax.ejb.EJBException,
                                            IdWrongFormatException,
                                            UnexpectedFailureException
Deprecated. No longer needed for BPEL processes. A fault message can be read without specifying the fault name - see getFaultMessage(PIID).

Retrieves the fault terminal names of the specified process instance using the process instance ID.

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

Note: An instance of a schema 5.0 process migrated to BPEL, returns the name of the actually thrown fault.

Parameters:
piid - The object ID of the process instance for which the fault terminal names are to be retrieved.

Returns:
List - A list of fault terminal names. If there are no fault terminals, an empty list is returned.

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

getFaultTerminalNames

public java.util.List getFaultTerminalNames(AIID aiid)
                                     throws java.rmi.RemoteException,
                                            javax.ejb.EJBException,
                                            EngineNotAuthorizedException,
                                            EngineWrongKindException,
                                            EngineWrongStateException,
                                            IdWrongFormatException,
                                            ObjectDoesNotExistException,
                                            UnexpectedFailureException
Deprecated. For BPEL processes replaced by getFaultNames(AIID).

Retrieves the fault terminal names of the specified activity instance using the activity instance ID.

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

Note: A BPEL process activity returns the names of faults of staff and stopped invoke activities.

Parameters:
aiid - The object ID of the activity instance for which the fault terminal names are to be retrieved.

Returns:
List - A list of fault terminal names. If there are no fault terminals, an empty list is returned.

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

getFaultMessage

public ClientObjectWrapper getFaultMessage(java.lang.String identifier,
                                           java.lang.String faultTerminalName)
                                    throws java.rmi.RemoteException,
                                           javax.ejb.EJBException,
                                           DataHandlingException,
                                           EngineCannotInitializePluginException,
                                           EngineDataPluginException,
                                           EngineNotAuthorizedException,
                                           EngineParameterNullException,
                                           EngineWrongKindException,
                                           EngineWrongStateException,
                                           IdWrongFormatException,
                                           IdWrongTypeException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException
Deprecated. The fault message of a BPEL process can be read without specifying the fault name - see getFaultMessage(String).

Retrieves the specified fault message of the specified process or activity instance using a string representation of the ID.

The fault message 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.

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.
faultTerminalName - The name of the fault message to be retrieved.

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

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
DataHandlingException
EngineCannotInitializePluginException
EngineDataPluginException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getFaultMessage

public ClientObjectWrapper getFaultMessage(PIID piid,
                                           java.lang.String faultTerminalName)
                                    throws java.rmi.RemoteException,
                                           javax.ejb.EJBException,
                                           EngineCannotInitializePluginException,
                                           EngineDataPluginException,
                                           EngineNotAuthorizedException,
                                           EngineParameterNullException,
                                           EngineWrongKindException,
                                           EngineWrongStateException,
                                           IdWrongFormatException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException
Deprecated. The fault message of a BPEL process can be read without specifying the fault name - see getFaultMessage(PIID).

Retrieves the specified 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.

Parameters:
piid - The object ID of the process instance for which the fault message is to be retrieved.
faultTerminalName - The name of the fault message to be retrieved.

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

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getFaultMessage

public ClientObjectWrapper getFaultMessage(AIID aiid,
                                           java.lang.String faultTerminalName)
                                    throws java.rmi.RemoteException,
                                           javax.ejb.EJBException,
                                           DataHandlingException,
                                           EngineCannotInitializePluginException,
                                           EngineDataPluginException,
                                           EngineNotAuthorizedException,
                                           EngineParameterNullException,
                                           EngineWrongKindException,
                                           EngineWrongStateException,
                                           IdWrongFormatException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException
Deprecated. The fault message of a BPEL process can be read without specifying the fault name - see getFaultMessage(AIID).

Retrieves the specified fault message of the specified activity instance using the activity instance ID.

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

Parameters:
aiid - The object ID of the activity instance for which the fault message is to be retrieved.
faultTerminalName - The name of the fault message to be retrieved.

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

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
DataHandlingException
EngineCannotInitializePluginException
EngineDataPluginException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

setFaultMessage

public void setFaultMessage(java.lang.String aiid,
                            java.lang.String faultName,
                            ClientObjectWrapper faultMessage)
                     throws java.rmi.RemoteException,
                            javax.ejb.EJBException,
                            EngineCannotInitializePluginException,
                            EngineDataPluginException,
                            EngineInvalidFaultTerminalException,
                            EngineNotAuthorizedException,
                            EngineParameterNullException,
                            EngineWrongKindException,
                            EngineWrongMessageTypeException,
                            EngineWrongStateException,
                            IdWrongFormatException,
                            IdWrongTypeException,
                            ObjectDoesNotExistException,
                            UnexpectedFailureException
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.

For a BPEL process, the activity must be a staff activity. To repair variables used by a stopped invoke or script activity, refer to setVariable.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineInvalidFaultTerminalException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.0

setFaultMessage

public void setFaultMessage(AIID aiid,
                            java.lang.String faultName,
                            ClientObjectWrapper faultMessage)
                     throws java.rmi.RemoteException,
                            javax.ejb.EJBException,
                            EngineCannotInitializePluginException,
                            EngineDataPluginException,
                            EngineInvalidFaultTerminalException,
                            EngineNotAuthorizedException,
                            EngineParameterNullException,
                            EngineWrongKindException,
                            EngineWrongMessageTypeException,
                            EngineWrongStateException,
                            IdWrongFormatException,
                            ObjectDoesNotExistException,
                            UnexpectedFailureException
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.

For a BPEL process, the activity must be a staff activity. To repair variables used by a stopped invoke or script activity, refer to setVariable.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineInvalidFaultTerminalException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getVariable

public ClientObjectWrapper getVariable(java.lang.String piid,
                                       java.lang.String variableName)
                                throws java.rmi.RemoteException,
                                       javax.ejb.EJBException,
                                       EngineCannotInitializePluginException,
                                       EngineDataPluginException,
                                       EngineNotAuthorizedException,
                                       EngineParameterNullException,
                                       EngineVariableDoesNotExistException,
                                       EngineWrongStateException,
                                       IdWrongFormatException,
                                       IdWrongTypeException,
                                       ObjectDoesNotExistException,
                                       UnexpectedFailureException
Retrieves the specified variable of the specified process instance using a string representation of 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.

Parameters:
piid - A string representation of the process instance object ID. This string is used to identify 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 emtpty client object wrapper is returned.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineNotAuthorizedException
EngineParameterNullException
EngineVariableDoesNotExistException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getVariable

public ClientObjectWrapper getVariable(PIID piid,
                                       java.lang.String variableName)
                                throws java.rmi.RemoteException,
                                       javax.ejb.EJBException,
                                       EngineCannotInitializePluginException,
                                       EngineDataPluginException,
                                       EngineNotAuthorizedException,
                                       EngineParameterNullException,
                                       EngineVariableDoesNotExistException,
                                       EngineWrongStateException,
                                       IdWrongFormatException,
                                       ObjectDoesNotExistException,
                                       UnexpectedFailureException
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.

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 emtpty client object wrapper is returned.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineNotAuthorizedException
EngineParameterNullException
EngineVariableDoesNotExistException
EngineWrongStateException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

setVariable

public void setVariable(java.lang.String piid,
                        java.lang.String variableName,
                        ClientObjectWrapper message)
                 throws java.rmi.RemoteException,
                        javax.ejb.EJBException,
                        EngineNotAuthorizedException,
                        EngineParameterNullException,
                        EngineVariableDoesNotExistException,
                        EngineWrongKindException,
                        EngineWrongMessageTypeException,
                        EngineWrongStateException,
                        IdWrongFormatException,
                        IdWrongTypeException,
                        MethodNotApplicableException,
                        ObjectDoesNotExistException,
                        UnexpectedFailureException
For a BPEL process, sets the specified variable using the variable name and a string representation of 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.

Parameters:
piid - A string representation of the process instance object ID. This string 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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineNotAuthorizedException
EngineParameterNullException
EngineVariableDoesNotExistException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
MethodNotApplicableException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

setVariable

public void setVariable(PIID piid,
                        java.lang.String variableName,
                        ClientObjectWrapper message)
                 throws java.rmi.RemoteException,
                        javax.ejb.EJBException,
                        EngineNotAuthorizedException,
                        EngineParameterNullException,
                        EngineVariableDoesNotExistException,
                        EngineWrongKindException,
                        EngineWrongMessageTypeException,
                        EngineWrongStateException,
                        IdWrongFormatException,
                        MethodNotApplicableException,
                        ObjectDoesNotExistException,
                        UnexpectedFailureException
For a BPEL process, 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineNotAuthorizedException
EngineParameterNullException
EngineVariableDoesNotExistException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
MethodNotApplicableException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

createMessage

public ClientObjectWrapper createMessage(java.lang.String identifier,
                                         java.lang.String messageTypeName)
                                  throws java.rmi.RemoteException,
                                         javax.ejb.EJBException,
                                         EngineDataPluginException,
                                         EngineNotAuthorizedException,
                                         EngineWrongKindException,
                                         IdWrongFormatException,
                                         IdWrongTypeException,
                                         ObjectDoesNotExistException,
                                         UnexpectedFailureException
Creates a message defined by the specified process template, process instance, or activity instance using a string representation of the process template ID, the process instance ID, or the activity instance ID. For example, create a message that can be used when activating an activity.

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

Parameters:
identifier - String representation of the object ID that is used to identify the process template, process instance, 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.

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

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

createMessage

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

The caller must be authorized for the process template.

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.

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

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

createMessage

public ClientObjectWrapper createMessage(PIID piid,
                                         java.lang.String messageTypeName)
                                  throws java.rmi.RemoteException,
                                         javax.ejb.EJBException,
                                         EngineDataPluginException,
                                         EngineNotAuthorizedException,
                                         IdWrongFormatException,
                                         ObjectDoesNotExistException,
                                         UnexpectedFailureException
Creates a message defined by the specified process instance using the process instance ID.

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

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.

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

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

createMessage

public ClientObjectWrapper createMessage(AIID aiid,
                                         java.lang.String messageTypeName)
                                  throws java.rmi.RemoteException,
                                         javax.ejb.EJBException,
                                         EngineDataPluginException,
                                         EngineNotAuthorizedException,
                                         EngineWrongKindException,
                                         IdWrongFormatException,
                                         ObjectDoesNotExistException,
                                         UnexpectedFailureException
Creates a message defined by the specified activity instance using the activity instance ID. For example, create 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.

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. The message type can be the name of a fault defined for the activity - refer to getFaultNames. Note that the structure of a BPEL fault name is a QName.

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

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

createMessage

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

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

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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineNotAuthorizedException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

createMessage

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

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

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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineNotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getCustomAttribute

public java.lang.String getCustomAttribute(java.lang.String identifier,
                                           java.lang.String attributeName)
                                    throws java.rmi.RemoteException,
                                           javax.ejb.EJBException,
                                           EngineCannotInitializePluginException,
                                           EngineNotAuthorizedException,
                                           EngineParameterNullException,
                                           EngineWrongKindException,
                                           EngineWrongStateException,
                                           IdWrongFormatException,
                                           IdWrongTypeException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException
Deprecated. For Bpel processes replaced by getCustomProperty(String,String).

Retrieves the named custom attribute of the specified process template, process instance, or activity instance using a string representation of the ID.

Custom attributes allow a user to add additional properties to processes and activities, beyond those provided and managed by the process engine.

A custom attribute 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.

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 attribute is to be retrieved.
attributeName - The name of the custom attribute for which the value is to be retrieved.

Returns:
String - The value of the specified custom attribute.

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

getCustomAttribute

public java.lang.String getCustomAttribute(PTID ptid,
                                           java.lang.String attributeName)
                                    throws java.rmi.RemoteException,
                                           javax.ejb.EJBException,
                                           EngineCannotInitializePluginException,
                                           EngineNotAuthorizedException,
                                           EngineParameterNullException,
                                           EngineWrongKindException,
                                           IdWrongFormatException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException
Deprecated. For Bpel processes replaced by getCustomProperty(PTID,String).

Retrieves the named custom attribute of the specified process template using the process template ID.

Custom attributes allow a user to add additional properties to a process, beyond those provided and managed by the process engine.

The caller must be authorized for the process template.

Parameters:
ptid - The process template object ID whose named custom attribute is to be retrieved.
attributeName - The name of the custom attribute for which the value is to be read.

Returns:
String - The value of the specified custom attribute.

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

getCustomAttribute

public java.lang.String getCustomAttribute(AIID aiid,
                                           java.lang.String attributeName)
                                    throws java.rmi.RemoteException,
                                           javax.ejb.EJBException,
                                           EngineCannotInitializePluginException,
                                           EngineNotAuthorizedException,
                                           EngineParameterNullException,
                                           EngineWrongKindException,
                                           EngineWrongStateException,
                                           IdWrongFormatException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException
Deprecated. For Bpel processes replaced by getCustomProperty(AIID,String).

Retrieves the named custom attribute of the specified activity instance using the activity instance ID.

Custom attributes allow a user to add additional properties to an activity, beyond those provided and managed by the process engine.

A custom attribute 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.

Parameters:
aiid - The activity instance object ID whose named custom attribute is to be retrieved.
attributeName - The name of the custom attribute for which the value is to be read.

Returns:
String - The value of the specified custom attribute.

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

getCustomAttribute

public java.lang.String getCustomAttribute(PIID piid,
                                           java.lang.String attributeName)
                                    throws java.rmi.RemoteException,
                                           javax.ejb.EJBException,
                                           EngineCannotInitializePluginException,
                                           EngineNotAuthorizedException,
                                           EngineParameterNullException,
                                           EngineWrongStateException,
                                           IdWrongFormatException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException
Deprecated. For Bpel processes replaced by getCustomProperty(PIID,String).

Retrieves the named custom attribute of the specified process instance using the process instance ID.

Custom attributes allow a user to add additional properties to a process, beyond those provided and managed by the process engine.

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

Parameters:
piid - The process instance object ID for which the named custom attribute is to be retrieved.
attributeName - The name of the custom attribute for which the value is to be retrieved.

Returns:
String - The value of the specified custom attribute.

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

setCustomAttribute

public void setCustomAttribute(java.lang.String identifier,
                               java.lang.String attributeName,
                               java.lang.String attributeValue)
                        throws java.rmi.RemoteException,
                               javax.ejb.EJBException,
                               EngineCannotInitializePluginException,
                               EngineCustomAttributeAccessViolationException,
                               EngineNotAuthorizedException,
                               EngineParameterNullException,
                               EngineWrongKindException,
                               EngineWrongStateException,
                               IdWrongFormatException,
                               IdWrongTypeException,
                               InvalidLengthException,
                               ObjectDoesNotExistException,
                               UnexpectedFailureException
Deprecated. For Bpel processes replaced by setCustomProperty(String,String,String).

Stores custom-specific values for the specified process or activity instance using a string representation of the ID.

Custom attributes allow a user to add additional properties to processes and activities, beyond those provided and managed by the process engine. A custom attribute has a name and a value of type string.

When custom attributes of a process instance are stored, the process instance can be in any execution state. The caller must be the starter or an administrator of the process instance.

When custom attributes of an activity instance are stored, the activity instance must be in the ready or claimed 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.

Parameters:
identifier - A string representation of the process or activity instance object ID that is used to identify the process or activity instance.
attributeName - The name of the custom attribute to be set. The name must not be greater than 220 bytes in UTF-8 format.
attributeValue - The custom value to be set. The value must not be greater than 254 bytes in UTF-8 format.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineCustomAttributeAccessViolationException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

setCustomAttribute

public void setCustomAttribute(AIID aiid,
                               java.lang.String attributeName,
                               java.lang.String attributeValue)
                        throws java.rmi.RemoteException,
                               javax.ejb.EJBException,
                               EngineCannotInitializePluginException,
                               EngineCustomAttributeAccessViolationException,
                               EngineNotAuthorizedException,
                               EngineParameterNullException,
                               EngineWrongKindException,
                               EngineWrongStateException,
                               IdWrongFormatException,
                               InvalidLengthException,
                               ObjectDoesNotExistException,
                               UnexpectedFailureException
Deprecated. For Bpel processes replaced by setCustomProperty(AIID,String,String).

Stores custom-specific values for the specified activity instance using the activity instance ID.

Custom attributes allow a user to add additional properties to activities, beyond those provided and managed by the process engine. A custom attribute has a name and a value of type string.

The activity instance must be in the ready or claimed 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.

Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance.
attributeName - The name of the custom attribute to be set. The name must not be greater than 220 bytes in UTF-8 format.
attributeValue - The custom value to be set. The value must not be greater than 254 bytes in UTF-8 format.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineCustomAttributeAccessViolationException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

setCustomAttribute

public void setCustomAttribute(PIID piid,
                               java.lang.String attributeName,
                               java.lang.String attributeValue)
                        throws java.rmi.RemoteException,
                               javax.ejb.EJBException,
                               EngineCannotInitializePluginException,
                               EngineCustomAttributeAccessViolationException,
                               EngineNotAuthorizedException,
                               EngineParameterNullException,
                               EngineWrongKindException,
                               EngineWrongStateException,
                               IdWrongFormatException,
                               InvalidLengthException,
                               ObjectDoesNotExistException,
                               UnexpectedFailureException
Deprecated. For Bpel processes replaced by setCustomProperty(PIID,String,String).

Stores custom specific values for the specified process instance using the process instance ID.

Custom attributes allow a user to add additional properties to processes, beyond those provided and managed by the process engine. A custom attribute 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.

Parameters:
piid - A string representation of the process instance object ID that is used to identify the process instance.
attributeName - The name of the custom attribute to be set. The name must not be greater than 220 bytes in UTF-8 format.
attributeValue - The custom value to be set. The value must not be greater than 254 bytes in UTF-8 format.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineCustomAttributeAccessViolationException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getCustomProperty

public java.lang.String getCustomProperty(java.lang.String identifier,
                                          java.lang.String propertyName)
                                   throws java.rmi.RemoteException,
                                          javax.ejb.EJBException,
                                          EngineNotAuthorizedException,
                                          EngineParameterNullException,
                                          EngineWrongKindException,
                                          EngineWrongStateException,
                                          IdWrongFormatException,
                                          IdWrongTypeException,
                                          MethodNotApplicableException,
                                          ObjectDoesNotExistException,
                                          UnexpectedFailureException
For BPEL processes, 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 or activity instance.

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 when the specified property cannot be found.

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

getCustomProperty

public java.lang.String getCustomProperty(PTID ptid,
                                          java.lang.String propertyName)
                                   throws java.rmi.RemoteException,
                                          javax.ejb.EJBException,
                                          EngineNotAuthorizedException,
                                          EngineParameterNullException,
                                          EngineWrongKindException,
                                          IdWrongFormatException,
                                          MethodNotApplicableException,
                                          ObjectDoesNotExistException,
                                          UnexpectedFailureException
For BPEL processes, 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.

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 when the specified property cannot be found.

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

getCustomProperty

public java.lang.String getCustomProperty(PIID piid,
                                          java.lang.String propertyName)
                                   throws java.rmi.RemoteException,
                                          javax.ejb.EJBException,
                                          EngineNotAuthorizedException,
                                          EngineParameterNullException,
                                          EngineWrongStateException,
                                          IdWrongFormatException,
                                          MethodNotApplicableException,
                                          ObjectDoesNotExistException,
                                          UnexpectedFailureException
For BPEL processes, 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 properties can be retrieved in any execution state of the process instance. The caller must have at least reader authority for the process instance.

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 when the specified property cannot be found.

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

getCustomProperty

public java.lang.String getCustomProperty(AIID aiid,
                                          java.lang.String propertyName)
                                   throws java.rmi.RemoteException,
                                          javax.ejb.EJBException,
                                          EngineNotAuthorizedException,
                                          EngineParameterNullException,
                                          EngineWrongKindException,
                                          EngineWrongStateException,
                                          IdWrongFormatException,
                                          MethodNotApplicableException,
                                          ObjectDoesNotExistException,
                                          UnexpectedFailureException
For BPEL processes, 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 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.

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 when the specified property cannot be found.

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

setCustomProperty

public void setCustomProperty(java.lang.String identifier,
                              java.lang.String propertyName,
                              java.lang.String propertyValue)
                       throws java.rmi.RemoteException,
                              javax.ejb.EJBException,
                              EngineNotAuthorizedException,
                              EngineParameterNullException,
                              EngineWrongKindException,
                              EngineWrongStateException,
                              IdWrongFormatException,
                              IdWrongTypeException,
                              InvalidLengthException,
                              MethodNotApplicableException,
                              ObjectDoesNotExistException,
                              UnexpectedFailureException
For BPEL processes, 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
MethodNotApplicableException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

setCustomProperty

public void setCustomProperty(PIID piid,
                              java.lang.String propertyName,
                              java.lang.String propertyValue)
                       throws java.rmi.RemoteException,
                              javax.ejb.EJBException,
                              EngineNotAuthorizedException,
                              EngineParameterNullException,
                              EngineWrongKindException,
                              EngineWrongStateException,
                              IdWrongFormatException,
                              InvalidLengthException,
                              MethodNotApplicableException,
                              ObjectDoesNotExistException,
                              UnexpectedFailureException
For BPEL processes, 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.

Parameters:
piid - A string representation of the process instance object ID that is used to identify the process 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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
MethodNotApplicableException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

setCustomProperty

public void setCustomProperty(AIID aiid,
                              java.lang.String propertyName,
                              java.lang.String propertyValue)
                       throws java.rmi.RemoteException,
                              javax.ejb.EJBException,
                              EngineNotAuthorizedException,
                              EngineParameterNullException,
                              EngineWrongKindException,
                              EngineWrongStateException,
                              IdWrongFormatException,
                              InvalidLengthException,
                              MethodNotApplicableException,
                              ObjectDoesNotExistException,
                              UnexpectedFailureException
For BPEL processes, 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
MethodNotApplicableException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getUserInput

public UserInput[] getUserInput(java.lang.String aiid)
                         throws java.rmi.RemoteException,
                                javax.ejb.EJBException,
                                EngineCannotInitializePluginException,
                                EngineNotAuthorizedException,
                                EngineWrongKindException,
                                EngineWrongStateException,
                                IdWrongFormatException,
                                IdWrongTypeException,
                                ObjectDoesNotExistException,
                                UserInputInitException,
                                UnexpectedFailureException
Deprecated. 

Retrieves user input for the specified activity instance using a string representation of the activity instance ID.

User input provides input on predefined options. For example, to make decisions or to check tasks done.

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

Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance.

Returns:
UserInput[] - The user input.

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

getUserInput

public UserInput[] getUserInput(AIID aiid)
                         throws java.rmi.RemoteException,
                                javax.ejb.EJBException,
                                EngineCannotInitializePluginException,
                                EngineNotAuthorizedException,
                                EngineWrongKindException,
                                EngineWrongStateException,
                                ObjectDoesNotExistException,
                                UserInputInitException,
                                UnexpectedFailureException
Deprecated. 

Retrieves user input for the specified activity instance using the activity instance ID.

User input provides input on predefined options. For example, to make decisions or to check tasks done.

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

Parameters:
aiid - The activity instance object ID whose user input is to be retrieved.

Returns:
UserInput[] - The user input values.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
ObjectDoesNotExistException
UserInputInitException
UnexpectedFailureException
Since:
5.0

setUserInput

public void setUserInput(java.lang.String aiid,
                         UserInput[] userInput)
                  throws java.rmi.RemoteException,
                         javax.ejb.EJBException,
                         EngineCannotInitializePluginException,
                         EngineNotAuthorizedException,
                         EngineWrongKindException,
                         EngineWrongStateException,
                         IdWrongFormatException,
                         IdWrongTypeException,
                         InvalidLengthException,
                         ObjectDoesNotExistException,
                         UnexpectedFailureException
Deprecated. 

Stores user input for the specified activity instance using a string representation of the activity instance ID.

User input provides input on predefined options. For example, to make decisions or to check tasks done.

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 have editor authority for the activity instance, be the owner of the activity instance, or be the administrator of the associated process instance.

Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance.
userInput - The user input to be stored.

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

setUserInput

public void setUserInput(AIID aiid,
                         UserInput[] userInput)
                  throws java.rmi.RemoteException,
                         javax.ejb.EJBException,
                         EngineCannotInitializePluginException,
                         EngineNotAuthorizedException,
                         EngineWrongKindException,
                         EngineWrongStateException,
                         InvalidLengthException,
                         ObjectDoesNotExistException,
                         UnexpectedFailureException
Deprecated. 

Stores user input for the specified activity instance using the activity instance ID.

User input provides input on predefined options. For example, to make decisions or to check tasks done.

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 have editor authority for the activity instance, be the owner of the activity instance, or be the administrator of the associated process instance.

Parameters:
aiid - The object ID of the activity instance.
userInput - The user input to be stored.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.0

getUISettings

public ClientObjectWrapper getUISettings(java.lang.String identifier,
                                         java.lang.String typeSystem)
                                  throws java.rmi.RemoteException,
                                         javax.ejb.EJBException,
                                         IdWrongTypeException,
                                         IdWrongFormatException,
                                         UnexpectedFailureException
Deprecated. 

Retrieves user interface settings for the specified process template, process instance, or activity instance using a string representation of the ID.

User interface settings can be specified for each user-specified type system. For example, there can be settings for a Web client.

User interface settings can always be retrieved for process templates. They 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.

Parameters:
identifier - A string representation of either a process template, a process instance, or an activity instance object ID.
typeSystem - The system type for which the user interface setting is to be retrieved.

Returns:
ClientObjectWrapper - The user interface settings.

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

getUISettings

public ClientObjectWrapper getUISettings(PTID ptid,
                                         java.lang.String typeSystem)
                                  throws java.rmi.RemoteException,
                                         javax.ejb.EJBException,
                                         IdWrongTypeException,
                                         UnexpectedFailureException
Deprecated. 

Retrieves user interface settings for the specified process template using the process template ID.

User interface settings can be specified for each user-specified type system. For example, there can be settings for a Web client.

The caller must be authorized for the process template.

Parameters:
ptid - The object ID of the process template.
typeSystem - The system type for which the user interface setting is to be retrieved.

Returns:
ClientObjectWrapper - The user interface settings.

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

getUISettings

public ClientObjectWrapper getUISettings(PIID piid,
                                         java.lang.String typeSystem)
                                  throws java.rmi.RemoteException,
                                         javax.ejb.EJBException,
                                         IdWrongTypeException,
                                         UnexpectedFailureException
Deprecated. 

Retrieves user interface settings for the specified process instance using the process instance ID.

User interface settings can be specified for each user-specified type system. For example, there can be settings for a Web client.

User 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.

Parameters:
piid - The object ID of the process instance.
typeSystem - The system type for which the user interface setting is to be retrieved.

Returns:
ClientObjectWrapper - The user interface settings.

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

getUISettings

public ClientObjectWrapper getUISettings(AIID aiid,
                                         java.lang.String typeSystem)
                                  throws java.rmi.RemoteException,
                                         javax.ejb.EJBException,
                                         IdWrongTypeException,
                                         UnexpectedFailureException
Deprecated. 

Retrieves user interface settings for the specified activity instance using the activity instance ID.

User interface settings can be specified for each user-specified type system. For example, there can be settings for a Web client.

User 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.

Parameters:
aiid - The object ID of the activity instance.
typeSystem - The system type for which the user interface setting is to be retrieved.

Returns:
ClientObjectWrapper - The user interface settings.

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

claim

public ClientObjectWrapper claim(java.lang.String aiid)
                          throws java.rmi.RemoteException,
                                 javax.ejb.EJBException,
                                 EngineCannotCreateWorkItemException,
                                 EngineCannotInitializePluginException,
                                 EngineNotAuthorizedException,
                                 EngineWrongKindException,
                                 EngineWrongStateException,
                                 IdWrongFormatException,
                                 IdWrongTypeException,
                                 InvalidLengthException,
                                 ObjectDoesNotExistException,
                                 UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotCreateWorkItemException
EngineCannotInitializePluginException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.0

claim

public ClientObjectWrapper claim(AIID aiid)
                          throws java.rmi.RemoteException,
                                 javax.ejb.EJBException,
                                 EngineCannotCreateWorkItemException,
                                 EngineCannotInitializePluginException,
                                 EngineNotAuthorizedException,
                                 EngineWrongKindException,
                                 EngineWrongStateException,
                                 IdWrongFormatException,
                                 InvalidLengthException,
                                 ObjectDoesNotExistException,
                                 UnexpectedFailureException
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.

Parameters:
aiid - The object ID of the activity instance to be claimed.

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

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotCreateWorkItemException
EngineCannotInitializePluginException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

claim

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

The activity instance that is claimed is identified by the specified where- and order-by-clauses. The first activity that qualifies under these conditions is claimed.

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

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".

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.

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 within a BPEL process that qualifies, null is returned. Refer to ActivityInstanceData to view the activity instance properties.

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

cancelClaim

public void cancelClaim(java.lang.String aiid)
                 throws java.rmi.RemoteException,
                        javax.ejb.EJBException,
                        EngineCannotInitializePluginException,
                        EngineFaultHasBeenNavigatedException,
                        EngineNotAuthorizedException,
                        EngineUncaughtExceptionInProcessException,
                        EngineWrongKindException,
                        EngineWrongStateException,
                        IdWrongFormatException,
                        IdWrongTypeException,
                        InvalidLengthException,
                        ObjectDoesNotExistException,
                        UnexpectedFailureException
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.

Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineFaultHasBeenNavigatedException
EngineNotAuthorizedException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.0

cancelClaim

public void cancelClaim(AIID aiid)
                 throws java.rmi.RemoteException,
                        javax.ejb.EJBException,
                        EngineCannotInitializePluginException,
                        EngineFaultHasBeenNavigatedException,
                        EngineNotAuthorizedException,
                        EngineUncaughtExceptionInProcessException,
                        EngineWrongKindException,
                        EngineWrongStateException,
                        IdWrongFormatException,
                        InvalidLengthException,
                        ObjectDoesNotExistException,
                        UnexpectedFailureException
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.

Parameters:
aiid - The activity instance object ID that is used to identify the activity instance.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineFaultHasBeenNavigatedException
EngineNotAuthorizedException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

complete

public void complete(java.lang.String aiid)
              throws java.rmi.RemoteException,
                     javax.ejb.EJBException,
                     EngineCannotInitializePluginException,
                     EngineDataPluginException,
                     EngineExitConditionFailedException,
                     EngineFaultHasBeenNavigatedException,
                     EngineIncompleteUserInputException,
                     EngineNotAuthorizedException,
                     EngineUncaughtExceptionInProcessException,
                     EngineWrongKindException,
                     EngineWrongStateException,
                     IdWrongFormatException,
                     IdWrongTypeException,
                     InvalidLengthException,
                     ObjectDoesNotExistException,
                     UserInputInitException,
                     UnexpectedFailureException
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.

For schema 5.0 process, the required user input must be set.

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. For schema 5.0 process, there are the following exceptions:

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: an output or fault message does not need to be set; navigation can continue with an empty message.

Parameters:
aiid - A string representation of the activity instance object ID that is used to identify the activity instance to be completed.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineExitConditionFailedException
EngineFaultHasBeenNavigatedException
EngineIncompleteUserInputException
EngineNotAuthorizedException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UserInputInitException
UnexpectedFailureException
Since:
5.0

complete

public void complete(AIID aiid)
              throws java.rmi.RemoteException,
                     javax.ejb.EJBException,
                     EngineCannotInitializePluginException,
                     EngineDataPluginException,
                     EngineExitConditionFailedException,
                     EngineFaultHasBeenNavigatedException,
                     EngineIncompleteUserInputException,
                     EngineNotAuthorizedException,
                     EngineUncaughtExceptionInProcessException,
                     EngineWrongKindException,
                     EngineWrongStateException,
                     IdWrongFormatException,
                     InvalidLengthException,
                     ObjectDoesNotExistException,
                     UserInputInitException,
                     UnexpectedFailureException
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.

For schema 5.0 process, the required user input must be set.

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. For schema 5.0 process, there are the following exceptions:

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: an output or fault message does not need to be set; navigation can continue with an empty message.

Parameters:
aiid - The object ID to identify the activity instance to be completed.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineExitConditionFailedException
EngineFaultHasBeenNavigatedException
EngineIncompleteUserInputException
EngineNotAuthorizedException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UserInputInitException
UnexpectedFailureException
Since:
5.1

complete

public void complete(AIID aiid,
                     ClientObjectWrapper output)
              throws java.rmi.RemoteException,
                     javax.ejb.EJBException,
                     EngineCannotInitializePluginException,
                     EngineDataPluginException,
                     EngineExitConditionFailedException,
                     EngineFaultHasBeenNavigatedException,
                     EngineIncompleteUserInputException,
                     EngineInvalidFaultTerminalException,
                     EngineNotAuthorizedException,
                     EngineParameterNullException,
                     EngineUncaughtExceptionInProcessException,
                     EngineWrongKindException,
                     EngineWrongMessageTypeException,
                     EngineWrongStateException,
                     IdWrongFormatException,
                     InvalidLengthException,
                     ObjectDoesNotExistException,
                     UserInputInitException,
                     UnexpectedFailureException
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.

For schema 5.0 process, the required user input must be set.

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. For schema 5.0 process, there are the following exceptions:

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

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineExitConditionFailedException
EngineFaultHasBeenNavigatedException
EngineIncompleteUserInputException
EngineInvalidFaultTerminalException
EngineNotAuthorizedException
EngineParameterNullException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UserInputInitException
UnexpectedFailureException
Since:
5.1

complete

public void complete(java.lang.String aiid,
                     ClientObjectWrapper output)
              throws java.rmi.RemoteException,
                     javax.ejb.EJBException,
                     EngineCannotInitializePluginException,
                     EngineDataPluginException,
                     EngineExitConditionFailedException,
                     EngineFaultHasBeenNavigatedException,
                     EngineIncompleteUserInputException,
                     EngineInvalidFaultTerminalException,
                     EngineNotAuthorizedException,
                     EngineParameterNullException,
                     EngineUncaughtExceptionInProcessException,
                     EngineWrongKindException,
                     EngineWrongMessageTypeException,
                     EngineWrongStateException,
                     IdWrongFormatException,
                     IdWrongTypeException,
                     InvalidLengthException,
                     ObjectDoesNotExistException,
                     UserInputInitException,
                     UnexpectedFailureException
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.

For schema 5.0 process, the required user input must be set.

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. For schema 5.0 process, there are the following exceptions:

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

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineExitConditionFailedException
EngineFaultHasBeenNavigatedException
EngineIncompleteUserInputException
EngineInvalidFaultTerminalException
EngineNotAuthorizedException
EngineParameterNullException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UserInputInitException
UnexpectedFailureException
Since:
5.0

complete

public void complete(AIID aiid,
                     ClientObjectWrapper faultMessage,
                     java.lang.String faultName)
              throws java.rmi.RemoteException,
                     javax.ejb.EJBException,
                     EngineCannotInitializePluginException,
                     EngineDataPluginException,
                     EngineExitConditionFailedException,
                     EngineFaultHasBeenNavigatedException,
                     EngineIncompleteUserInputException,
                     EngineInvalidFaultTerminalException,
                     EngineNotAuthorizedException,
                     EngineParameterNullException,
                     EngineUncaughtExceptionInProcessException,
                     EngineWrongKindException,
                     EngineWrongMessageTypeException,
                     EngineWrongStateException,
                     IdWrongFormatException,
                     InvalidLengthException,
                     ObjectDoesNotExistException,
                     UserInputInitException,
                     UnexpectedFailureException
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.

For schema 5.0 process, the required user input must be set.

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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineExitConditionFailedException
EngineFaultHasBeenNavigatedException
EngineIncompleteUserInputException
EngineInvalidFaultTerminalException
EngineNotAuthorizedException
EngineParameterNullException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UserInputInitException
UnexpectedFailureException
Since:
5.1

complete

public void complete(java.lang.String aiid,
                     ClientObjectWrapper faultMessage,
                     java.lang.String faultName)
              throws java.rmi.RemoteException,
                     javax.ejb.EJBException,
                     EngineCannotInitializePluginException,
                     EngineDataPluginException,
                     EngineExitConditionFailedException,
                     EngineFaultHasBeenNavigatedException,
                     EngineIncompleteUserInputException,
                     EngineInvalidFaultTerminalException,
                     EngineNotAuthorizedException,
                     EngineParameterNullException,
                     EngineUncaughtExceptionInProcessException,
                     EngineWrongKindException,
                     EngineWrongMessageTypeException,
                     EngineWrongStateException,
                     IdWrongFormatException,
                     IdWrongTypeException,
                     InvalidLengthException,
                     ObjectDoesNotExistException,
                     UserInputInitException,
                     UnexpectedFailureException
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.

For schema 5.0 process, the required user input must be set.

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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineExitConditionFailedException
EngineFaultHasBeenNavigatedException
EngineIncompleteUserInputException
EngineInvalidFaultTerminalException
EngineNotAuthorizedException
EngineParameterNullException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UserInputInitException
UnexpectedFailureException
Since:
5.0

call

public ClientObjectWrapper call(java.lang.String processTemplateName,
                                ClientObjectWrapper inputMessage)
                         throws java.rmi.RemoteException,
                                javax.ejb.EJBException,
                                CreateFailedException,
                                EngineAdministratorCannotBeResolvedException,
                                EngineCannotCreateWorkItemException,
                                EngineCannotInitializePluginException,
                                EngineCannotInitializeVariableException,
                                EngineCannotOpenCompensationSphereException,
                                EngineCannotRunSynchronousException,
                                EngineDataPluginException,
                                EngineFaultHasBeenNavigatedException,
                                FaultReplyException,
                                EngineNotAuthorizedException,
                                EngineProcessCompensatedException,
                                EngineProcessModelDoesNotExistException,
                                EngineProcessModelStoppedException,
                                EngineUncaughtExceptionInProcessException,
                                EngineWrongMessageTypeException,
                                InvalidLengthException,
                                ProcessException,
                                ServiceNotUniqueException,
                                UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
CreateFailedException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializePluginException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotRunSynchronousException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
FaultReplyException
EngineNotAuthorizedException
EngineProcessCompensatedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineUncaughtExceptionInProcessException
EngineWrongMessageTypeException
InvalidLengthException
ProcessException
ServiceNotUniqueException
UnexpectedFailureException
Since:
5.1

call

public ClientObjectWrapper call(java.lang.String vtid,
                                java.lang.String atid,
                                ClientObjectWrapper inputMessage)
                         throws java.rmi.RemoteException,
                                javax.ejb.EJBException,
                                CreateFailedException,
                                EngineCannotRunSynchronousException,
                                EngineNotAuthorizedException,
                                EngineProcessModelDoesNotExistException,
                                EngineProcessModelStoppedException,
                                FaultReplyException,
                                IdWrongFormatException,
                                IdWrongTypeException,
                                ObjectDoesNotExistException,
                                ProcessException,
                                UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
CreateFailedException
EngineCannotRunSynchronousException
EngineNotAuthorizedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
FaultReplyException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
ProcessException
UnexpectedFailureException
Since:
5.1.1

call

public ClientObjectWrapper call(VTID vtid,
                                ATID atid,
                                ClientObjectWrapper inputMessage)
                         throws java.rmi.RemoteException,
                                javax.ejb.EJBException,
                                CreateFailedException,
                                EngineCannotRunSynchronousException,
                                EngineNotAuthorizedException,
                                EngineProcessModelDoesNotExistException,
                                EngineProcessModelStoppedException,
                                FaultReplyException,
                                IdWrongFormatException,
                                IdWrongTypeException,
                                ObjectDoesNotExistException,
                                ProcessException,
                                UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
CreateFailedException
EngineCannotRunSynchronousException
EngineNotAuthorizedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
FaultReplyException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
ProcessException
UnexpectedFailureException
Since:
5.1.1

call

public ClientObjectWrapper call(java.lang.String processTemplateName,
                                ClientObjectWrapper inputMessage,
                                java.util.Map variables)
                         throws java.rmi.RemoteException,
                                javax.ejb.EJBException,
                                EngineAdministratorCannotBeResolvedException,
                                EngineCannotCreateWorkItemException,
                                EngineCannotInitializePluginException,
                                EngineCannotInitializeVariableException,
                                EngineCannotOpenCompensationSphereException,
                                EngineCannotRunSynchronousException,
                                EngineDataPluginException,
                                EngineFaultHasBeenNavigatedException,
                                EngineNotAuthorizedException,
                                EngineProcessCompensatedException,
                                EngineProcessModelDoesNotExistException,
                                EngineProcessModelStoppedException,
                                EngineUncaughtExceptionInProcessException,
                                EngineWrongMessageTypeException,
                                InvalidLengthException,
                                ProcessException,
                                UnexpectedFailureException
Deprecated. 

Creates and executes a process instance from the specified process template passing variable values. An input message and a map of variables can be passed to specify initial values for the process instance.

This method is only applicable to schema 5.0 processes.

The 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.

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.
variables - The map of variables that specify their initial values; must be a map of ClientObjectWrapper objects. The objects wrapped must be serializable.

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

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializePluginException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotRunSynchronousException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
EngineNotAuthorizedException
EngineProcessCompensatedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineUncaughtExceptionInProcessException
EngineWrongMessageTypeException
InvalidLengthException
ProcessException
UnexpectedFailureException
Since:
5.0

callWithReplyContext

public void callWithReplyContext(java.lang.String processTemplateName,
                                 ClientObjectWrapper inputMessage,
                                 ReplyContextWrapper replyContext)
                          throws java.rmi.RemoteException,
                                 javax.ejb.EJBException,
                                 CreateFailedException,
                                 EngineAdministratorCannotBeResolvedException,
                                 EngineCannotCreateWorkItemException,
                                 EngineCannotInitializePluginException,
                                 EngineCannotInitializeVariableException,
                                 EngineCannotOpenCompensationSphereException,
                                 EngineCannotUnwrapReplyContextException,
                                 EngineDataPluginException,
                                 EngineFaultHasBeenNavigatedException,
                                 FaultReplyException,
                                 EngineNotAuthorizedException,
                                 EngineProcessCompensatedException,
                                 EngineProcessModelDoesNotExistException,
                                 EngineProcessModelStoppedException,
                                 EngineUncaughtExceptionInProcessException,
                                 EngineWrongMessageTypeException,
                                 InvalidLengthException,
                                 MissingPartsException,
                                 ProcessException,
                                 ProcessInstanceNotUniqueException,
                                 SendReplyErrorException,
                                 ServiceNotUniqueException,
                                 UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
CreateFailedException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializePluginException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotUnwrapReplyContextException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
FaultReplyException
EngineNotAuthorizedException
EngineProcessCompensatedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineUncaughtExceptionInProcessException
EngineWrongMessageTypeException
InvalidLengthException
MissingPartsException
ProcessException
ProcessInstanceNotUniqueException
SendReplyErrorException
ServiceNotUniqueException
UnexpectedFailureException
Since:
5.1

callWithReplyContext

public void callWithReplyContext(java.lang.String processTemplateName,
                                 java.lang.String processInstanceName,
                                 ClientObjectWrapper inputMessage,
                                 ReplyContextWrapper replyContext)
                          throws java.rmi.RemoteException,
                                 javax.ejb.EJBException,
                                 CreateFailedException,
                                 EngineAdministratorCannotBeResolvedException,
                                 EngineCannotCreateWorkItemException,
                                 EngineCannotInitializePluginException,
                                 EngineCannotInitializeVariableException,
                                 EngineCannotOpenCompensationSphereException,
                                 EngineCannotUnwrapReplyContextException,
                                 EngineDataPluginException,
                                 EngineFaultHasBeenNavigatedException,
                                 FaultReplyException,
                                 EngineNotAuthorizedException,
                                 EngineProcessCompensatedException,
                                 EngineProcessInstanceNameNotUniqueException,
                                 EngineProcessModelDoesNotExistException,
                                 EngineProcessModelStoppedException,
                                 EngineUncaughtExceptionInProcessException,
                                 EngineWrongMessageTypeException,
                                 InvalidLengthException,
                                 MissingPartsException,
                                 ProcessException,
                                 ProcessInstanceNotUniqueException,
                                 SendReplyErrorException,
                                 ServiceNotUniqueException,
                                 UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
CreateFailedException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializePluginException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotUnwrapReplyContextException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
FaultReplyException
EngineNotAuthorizedException
EngineProcessCompensatedException
EngineProcessInstanceNameNotUniqueException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineUncaughtExceptionInProcessException
EngineWrongMessageTypeException
InvalidLengthException
MissingPartsException
ProcessException
ProcessInstanceNotUniqueException
SendReplyErrorException
ServiceNotUniqueException
UnexpectedFailureException
Since:
5.1

callWithReplyContext

public void callWithReplyContext(java.lang.String processTemplateName,
                                 ClientObjectWrapper inputMessage,
                                 ReplyContextWrapper replyContext,
                                 int invocationCount,
                                 java.lang.String requestId)
                          throws java.rmi.RemoteException,
                                 javax.ejb.EJBException,
                                 CreateFailedException,
                                 EngineAdministratorCannotBeResolvedException,
                                 EngineCannotCreateWorkItemException,
                                 EngineCannotInitializePluginException,
                                 EngineCannotInitializeVariableException,
                                 EngineCannotOpenCompensationSphereException,
                                 EngineCannotUnwrapReplyContextException,
                                 EngineDataPluginException,
                                 EngineFaultHasBeenNavigatedException,
                                 FaultReplyException,
                                 EngineNotAuthorizedException,
                                 EngineProcessCompensatedException,
                                 EngineProcessModelDoesNotExistException,
                                 EngineProcessModelStoppedException,
                                 EngineUncaughtExceptionInProcessException,
                                 EngineWrongMessageTypeException,
                                 InvalidLengthException,
                                 MissingPartsException,
                                 ProcessException,
                                 ProcessInstanceNotUniqueException,
                                 SendReplyErrorException,
                                 ServiceNotUniqueException,
                                 UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
CreateFailedException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializePluginException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotUnwrapReplyContextException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
FaultReplyException
EngineNotAuthorizedException
EngineProcessCompensatedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineUncaughtExceptionInProcessException
EngineWrongMessageTypeException
InvalidLengthException
MissingPartsException
ProcessException
ProcessInstanceNotUniqueException
SendReplyErrorException
ServiceNotUniqueException
UnexpectedFailureException
Since:
5.1

callWithReplyContext

public void callWithReplyContext(java.lang.String processTemplateName,
                                 java.lang.String processInstanceName,
                                 ClientObjectWrapper inputMessage,
                                 ReplyContextWrapper replyContext,
                                 int invocationCount,
                                 java.lang.String requestId)
                          throws java.rmi.RemoteException,
                                 javax.ejb.EJBException,
                                 CreateFailedException,
                                 EngineAdministratorCannotBeResolvedException,
                                 EngineCannotCreateWorkItemException,
                                 EngineCannotInitializePluginException,
                                 EngineCannotInitializeVariableException,
                                 EngineCannotOpenCompensationSphereException,
                                 EngineCannotUnwrapReplyContextException,
                                 EngineDataPluginException,
                                 EngineFaultHasBeenNavigatedException,
                                 FaultReplyException,
                                 EngineNotAuthorizedException,
                                 EngineProcessCompensatedException,
                                 EngineProcessInstanceNameNotUniqueException,
                                 EngineProcessModelDoesNotExistException,
                                 EngineProcessModelStoppedException,
                                 EngineUncaughtExceptionInProcessException,
                                 EngineWrongMessageTypeException,
                                 InvalidLengthException,
                                 MissingPartsException,
                                 ProcessException,
                                 ProcessInstanceNotUniqueException,
                                 SendReplyErrorException,
                                 ServiceNotUniqueException,
                                 UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
CreateFailedException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializePluginException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotUnwrapReplyContextException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
FaultReplyException
EngineNotAuthorizedException
EngineProcessCompensatedException
EngineProcessInstanceNameNotUniqueException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineUncaughtExceptionInProcessException
EngineWrongMessageTypeException
InvalidLengthException
MissingPartsException
ProcessException
ProcessInstanceNotUniqueException
SendReplyErrorException
ServiceNotUniqueException
UnexpectedFailureException
Since:
5.1

callWithUISettings

public ProcessResponseWrapper callWithUISettings(java.lang.String processTemplateName,
                                                 ClientObjectWrapper inputMessage)
                                          throws java.rmi.RemoteException,
                                                 javax.ejb.EJBException,
                                                 CreateFailedException,
                                                 EngineCannotRunSynchronousException,
                                                 EngineNotAuthorizedException,
                                                 EngineProcessModelDoesNotExistException,
                                                 EngineProcessModelStoppedException,
                                                 FaultReplyException,
                                                 MethodNotApplicableException,
                                                 ProcessException,
                                                 ServiceNotUniqueException,
                                                 UnexpectedFailureException
Creates and executes a process instance that is derived from the specified BPEL 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 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
CreateFailedException
EngineCannotRunSynchronousException
EngineNotAuthorizedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
FaultReplyException
MethodNotApplicableException
ProcessException
ServiceNotUniqueException
UnexpectedFailureException
Since:
5.1.1

callWithUISettings

public ProcessResponseWrapper callWithUISettings(java.lang.String vtid,
                                                 java.lang.String atid,
                                                 ClientObjectWrapper inputMessage)
                                          throws java.rmi.RemoteException,
                                                 javax.ejb.EJBException,
                                                 CreateFailedException,
                                                 EngineCannotRunSynchronousException,
                                                 EngineNotAuthorizedException,
                                                 EngineProcessModelDoesNotExistException,
                                                 EngineProcessModelStoppedException,
                                                 FaultReplyException,
                                                 IdWrongFormatException,
                                                 IdWrongTypeException,
                                                 MethodNotApplicableException,
                                                 ObjectDoesNotExistException,
                                                 ProcessException,
                                                 ServiceNotUniqueException,
                                                 UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
CreateFailedException
EngineCannotRunSynchronousException
EngineNotAuthorizedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
FaultReplyException
IdWrongFormatException
IdWrongTypeException
MethodNotApplicableException
ObjectDoesNotExistException
ProcessException
ServiceNotUniqueException
UnexpectedFailureException
Since:
5.1.1

callWithUISettings

public ProcessResponseWrapper callWithUISettings(VTID vtid,
                                                 ATID atid,
                                                 ClientObjectWrapper inputMessage)
                                          throws java.rmi.RemoteException,
                                                 javax.ejb.EJBException,
                                                 CreateFailedException,
                                                 EngineCannotRunSynchronousException,
                                                 EngineNotAuthorizedException,
                                                 EngineProcessModelDoesNotExistException,
                                                 EngineProcessModelStoppedException,
                                                 FaultReplyException,
                                                 IdWrongFormatException,
                                                 ObjectDoesNotExistException,
                                                 ProcessException,
                                                 UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
CreateFailedException
EngineCannotRunSynchronousException
EngineNotAuthorizedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
FaultReplyException
IdWrongFormatException
ObjectDoesNotExistException
ProcessException
UnexpectedFailureException
Since:
5.1.1

initiate

public PIID initiate(java.lang.String processTemplateName,
                     ClientObjectWrapper inputMessage)
              throws java.rmi.RemoteException,
                     javax.ejb.EJBException,
                     CreateFailedException,
                     EngineAdministratorCannotBeResolvedException,
                     EngineCannotCreateWorkItemException,
                     EngineCannotInitializePluginException,
                     EngineCannotInitializeVariableException,
                     EngineCannotOpenCompensationSphereException,
                     EngineCannotRunSynchronousException,
                     EngineDataPluginException,
                     EngineFaultHasBeenNavigatedException,
                     FaultReplyException,
                     EngineNotAuthorizedException,
                     EngineParameterNullException,
                     EngineProcessCompensatedException,
                     EngineProcessModelDoesNotExistException,
                     EngineProcessModelStoppedException,
                     EngineUncaughtExceptionInProcessException,
                     EngineWrongMessageTypeException,
                     InvalidLengthException,
                     InvalidObjectNameException,
                     MissingPartsException,
                     ProcessInstanceNotUniqueException,
                     ServiceNotUniqueException,
                     UnexpectedFailureException,
                     ProcessException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
CreateFailedException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializePluginException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotRunSynchronousException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
FaultReplyException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessCompensatedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineUncaughtExceptionInProcessException
EngineWrongMessageTypeException
InvalidLengthException
InvalidObjectNameException
MissingPartsException
ProcessInstanceNotUniqueException
ServiceNotUniqueException
UnexpectedFailureException
ProcessException
Since:
5.1

initiate

public PIID initiate(java.lang.String processTemplateName,
                     java.lang.String processInstanceName,
                     ClientObjectWrapper inputMessage)
              throws java.rmi.RemoteException,
                     javax.ejb.EJBException,
                     CreateFailedException,
                     EngineAdministratorCannotBeResolvedException,
                     EngineCannotCreateWorkItemException,
                     EngineCannotInitializePluginException,
                     EngineCannotInitializeVariableException,
                     EngineCannotOpenCompensationSphereException,
                     EngineCannotRunSynchronousException,
                     EngineDataPluginException,
                     EngineFaultHasBeenNavigatedException,
                     FaultReplyException,
                     EngineNotAuthorizedException,
                     EngineParameterNullException,
                     EngineProcessCompensatedException,
                     EngineProcessInstanceNameNotUniqueException,
                     EngineProcessModelDoesNotExistException,
                     EngineProcessModelStoppedException,
                     EngineUncaughtExceptionInProcessException,
                     EngineWrongMessageTypeException,
                     InvalidLengthException,
                     InvalidObjectNameException,
                     MissingPartsException,
                     ProcessInstanceNotUniqueException,
                     ServiceNotUniqueException,
                     UnexpectedFailureException,
                     ProcessException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
CreateFailedException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializePluginException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotRunSynchronousException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
FaultReplyException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessCompensatedException
EngineProcessInstanceNameNotUniqueException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineUncaughtExceptionInProcessException
EngineWrongMessageTypeException
InvalidLengthException
InvalidObjectNameException
MissingPartsException
ProcessInstanceNotUniqueException
ServiceNotUniqueException
UnexpectedFailureException
ProcessException
Since:
5.1

initiate

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

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:
java.rmi.RemoteException
javax.ejb.EJBException
CreateFailedException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessInstanceNameNotUniqueException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
IdWrongFormatException
IdWrongTypeException
InvalidObjectNameException
MissingPartsException
NoMacroFlowException
ObjectDoesNotExistException
ProcessInstanceNotUniqueException
UnexpectedFailureException
ProcessException
Since:
5.1.1

initiate

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

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:
java.rmi.RemoteException
javax.ejb.EJBException
CreateFailedException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessInstanceNameNotUniqueException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
IdWrongFormatException
InvalidObjectNameException
MissingPartsException
NoMacroFlowException
ObjectDoesNotExistException
ProcessInstanceNotUniqueException
UnexpectedFailureException
ProcessException
Since:
5.1.1

initiate

public PIID initiate(java.lang.String processTemplateName,
                     ClientObjectWrapper inputMessage,
                     java.util.Map variables)
              throws java.rmi.RemoteException,
                     javax.ejb.EJBException,
                     EngineAdministratorCannotBeResolvedException,
                     EngineCannotCreateWorkItemException,
                     EngineCannotInitializePluginException,
                     EngineCannotInitializeVariableException,
                     EngineCannotOpenCompensationSphereException,
                     EngineCannotRunSynchronousException,
                     EngineDataPluginException,
                     EngineFaultHasBeenNavigatedException,
                     EngineNotAuthorizedException,
                     EngineProcessCompensatedException,
                     EngineProcessModelDoesNotExistException,
                     EngineProcessModelStoppedException,
                     EngineUncaughtExceptionInProcessException,
                     EngineWrongMessageTypeException,
                     InvalidLengthException,
                     InvalidObjectNameException,
                     ProcessException,
                     UnexpectedFailureException
Deprecated. 

Creates a process instance from the specified process template, passes the specified input message and variables, and initiates processing of the process instance. The name of the newly created process instance is derived from its object identifier.

This method is only applicable to schema 5.0 processes.

The process template must indicate that derived process instances can run interrupted.

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. The starting activity instances are determined and either started automatically or, if they are person activities or receive events, work items are created.

Parameters:
processTemplateName - The name of the process template from which an instance is to be created.
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.
variables - The map of variables that specify their initial values; must be a map of ClientObjectWrapper objects. The objects wrapped must be serializable.

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

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializePluginException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotRunSynchronousException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
EngineNotAuthorizedException
EngineProcessCompensatedException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineUncaughtExceptionInProcessException
EngineWrongMessageTypeException
InvalidLengthException
InvalidObjectNameException
ProcessException
UnexpectedFailureException
Since:
5.0

initiate

public PIID initiate(java.lang.String processTemplateName,
                     java.lang.String processInstanceName,
                     ClientObjectWrapper inputMessage,
                     java.util.Map variables)
              throws java.rmi.RemoteException,
                     javax.ejb.EJBException,
                     EngineAdministratorCannotBeResolvedException,
                     EngineCannotCreateWorkItemException,
                     EngineCannotInitializePluginException,
                     EngineCannotInitializeVariableException,
                     EngineCannotOpenCompensationSphereException,
                     EngineCannotRunSynchronousException,
                     EngineDataPluginException,
                     EngineFaultHasBeenNavigatedException,
                     EngineNotAuthorizedException,
                     EngineProcessCompensatedException,
                     EngineProcessInstanceNameNotUniqueException,
                     EngineProcessModelDoesNotExistException,
                     EngineProcessModelStoppedException,
                     EngineUncaughtExceptionInProcessException,
                     EngineWrongMessageTypeException,
                     InvalidLengthException,
                     InvalidObjectNameException,
                     ProcessException,
                     UnexpectedFailureException
Deprecated. 

Creates a named process instance from the specified process template, passes the specified input message and variables, and initiates processing of the process instance.

This method is only applicable to schema 5.0 processes.

The process template must indicate that derived process instances can run interrupted.

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. The starting activity instances are determined and either started automatically or, if they are person activities or receive events, work items are created.

Parameters:
processTemplateName - The name of the process template from which an instance is to be created.
processInstanceName - The name of the process instance to be created; must not be greater than 220 bytes when converted to 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.
variables - The map of variables that specify their initial values; must be a map of ClientObjectWrapper objects. The objects wrapped must be serializable.

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

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineAdministratorCannotBeResolvedException
EngineCannotCreateWorkItemException
EngineCannotInitializePluginException
EngineCannotInitializeVariableException
EngineCannotOpenCompensationSphereException
EngineCannotRunSynchronousException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
EngineNotAuthorizedException
EngineProcessCompensatedException
EngineProcessInstanceNameNotUniqueException
EngineProcessModelDoesNotExistException
EngineProcessModelStoppedException
EngineUncaughtExceptionInProcessException
EngineWrongMessageTypeException
InvalidLengthException
InvalidObjectNameException
ProcessException
UnexpectedFailureException
Since:
5.0

forceTerminate

public void forceTerminate(java.lang.String identifier)
                    throws java.rmi.RemoteException,
                           javax.ejb.EJBException,
                           EngineCannotInitializePluginException,
                           EngineNotAuthorizedException,
                           EngineWrongStateException,
                           EngineWrongKindException,
                           IdWrongTypeException,
                           ObjectDoesNotExistException,
                           InvalidLengthException,
                           UnexpectedFailureException
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 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineNotAuthorizedException
EngineWrongStateException
EngineWrongKindException
IdWrongTypeException
ObjectDoesNotExistException
InvalidLengthException
UnexpectedFailureException
Since:
5.0

forceTerminate

public void forceTerminate(PIID piid)
                    throws java.rmi.RemoteException,
                           javax.ejb.EJBException,
                           EngineCannotInitializePluginException,
                           EngineNotAuthorizedException,
                           EngineWrongStateException,
                           EngineWrongKindException,
                           ObjectDoesNotExistException,
                           IdWrongFormatException,
                           InvalidLengthException,
                           UnexpectedFailureException
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 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.

Parameters:
piid - The object ID of the process instance to be terminated.

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

forceTerminate

public void forceTerminate(java.lang.String identifier,
                           int invokeCompensation)
                    throws java.rmi.RemoteException,
                           javax.ejb.EJBException,
                           EngineCannotInitializePluginException,
                           EngineNotAuthorizedException,
                           EngineWrongStateException,
                           EngineWrongKindException,
                           IdWrongTypeException,
                           ObjectDoesNotExistException,
                           InvalidLengthException,
                           InvalidParameterValueException,
                           UnexpectedFailureException
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 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.

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.

Note: Process instances derived from schema 5.0 process templates only support IGNORE_COMPENSATION.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineNotAuthorizedException
EngineWrongStateException
EngineWrongKindException
IdWrongTypeException
ObjectDoesNotExistException
InvalidLengthException
InvalidParameterValueException
UnexpectedFailureException
Since:
5.1

forceTerminate

public void forceTerminate(PIID piid,
                           int invokeCompensation)
                    throws java.rmi.RemoteException,
                           javax.ejb.EJBException,
                           EngineCannotInitializePluginException,
                           EngineNotAuthorizedException,
                           EngineWrongStateException,
                           EngineWrongKindException,
                           ObjectDoesNotExistException,
                           IdWrongFormatException,
                           InvalidLengthException,
                           InvalidParameterValueException,
                           UnexpectedFailureException
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 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.

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.

Note: Process instances derived from schema 5.0 process templates only support IGNORE_COMPENSATION.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineNotAuthorizedException
EngineWrongStateException
EngineWrongKindException
ObjectDoesNotExistException
IdWrongFormatException
InvalidLengthException
InvalidParameterValueException
UnexpectedFailureException
Since:
5.1

delete

public void delete(java.lang.String piid)
            throws java.rmi.RemoteException,
                   javax.ejb.EJBException,
                   EngineCannotDeleteProcessException,
                   EngineCannotInitializePluginException,
                   EngineNotAuthorizedException,
                   EngineWrongKindException,
                   EngineWrongStateException,
                   IdWrongFormatException,
                   IdWrongTypeException,
                   InvalidLengthException,
                   UnexpectedFailureException
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.

Parameters:
piid - A string representation of the process instance object ID that is used to identify the process instance to be deleted.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotDeleteProcessException
EngineCannotInitializePluginException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
UnexpectedFailureException
Since:
5.0

delete

public void delete(PIID piid)
            throws java.rmi.RemoteException,
                   javax.ejb.EJBException,
                   EngineCannotDeleteProcessException,
                   EngineCannotInitializePluginException,
                   EngineNotAuthorizedException,
                   EngineWrongKindException,
                   EngineWrongStateException,
                   IdWrongFormatException,
                   InvalidLengthException,
                   UnexpectedFailureException
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.

Parameters:
piid - The object ID of the process instance to be deleted.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotDeleteProcessException
EngineCannotInitializePluginException
EngineNotAuthorizedException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
UnexpectedFailureException
Since:
5.1

createWorkItem

public void createWorkItem(java.lang.String identifier,
                           int assignmentReason,
                           java.lang.String userID)
                    throws java.rmi.RemoteException,
                           javax.ejb.EJBException,
                           EngineEverybodyWorkItemException,
                           EngineNotAuthorizedException,
                           EngineParameterNullException,
                           EngineWrongKindException,
                           EngineWrongStateException,
                           IdWrongFormatException,
                           IdWrongTypeException,
                           InvalidLengthException,
                           MethodNotApplicableException,
                           ObjectDoesNotExistException,
                           WorkItemManagerException,
                           UnexpectedFailureException
Creates a work item for BPEL 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineEverybodyWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
MethodNotApplicableException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
Since:
5.1

createWorkItem

public void createWorkItem(PIID piid,
                           int assignmentReason,
                           java.lang.String userID)
                    throws java.rmi.RemoteException,
                           javax.ejb.EJBException,
                           EngineEverybodyWorkItemException,
                           EngineNotAuthorizedException,
                           EngineParameterNullException,
                           EngineWrongKindException,
                           EngineWrongStateException,
                           IdWrongFormatException,
                           InvalidLengthException,
                           MethodNotApplicableException,
                           ObjectDoesNotExistException,
                           WorkItemManagerException,
                           UnexpectedFailureException
Creates a work item for BPEL 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.

Parameters:
piid - 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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineEverybodyWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
MethodNotApplicableException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
Since:
5.1

createWorkItem

public void createWorkItem(AIID aiid,
                           int assignmentReason,
                           java.lang.String userID)
                    throws java.rmi.RemoteException,
                           javax.ejb.EJBException,
                           EngineEverybodyWorkItemException,
                           EngineNotAuthorizedException,
                           EngineParameterNullException,
                           EngineWrongKindException,
                           EngineWrongStateException,
                           IdWrongFormatException,
                           InvalidLengthException,
                           MethodNotApplicableException,
                           ObjectDoesNotExistException,
                           WorkItemManagerException,
                           UnexpectedFailureException
Creates a work item for BPEL 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineEverybodyWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
MethodNotApplicableException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
Since:
5.1

deleteWorkItem

public void deleteWorkItem(java.lang.String identifier,
                           int assignmentReason,
                           java.lang.String userID)
                    throws java.rmi.RemoteException,
                           javax.ejb.EJBException,
                           EngineEverybodyWorkItemException,
                           EngineLastAdminWorkItemException,
                           EngineNotAuthorizedException,
                           EngineParameterNullException,
                           EngineProcessReaderWorkItemException,
                           EngineWrongKindException,
                           EngineWrongStateException,
                           IdWrongFormatException,
                           IdWrongTypeException,
                           InvalidLengthException,
                           MethodNotApplicableException,
                           ObjectDoesNotExistException,
                           WorkItemManagerException,
                           UnexpectedFailureException
Deletes the specified work item using a string representation of either the BPEL 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineEverybodyWorkItemException
EngineLastAdminWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessReaderWorkItemException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
MethodNotApplicableException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
Since:
5.1

deleteWorkItem

public void deleteWorkItem(PIID piid,
                           int assignmentReason,
                           java.lang.String userID)
                    throws java.rmi.RemoteException,
                           javax.ejb.EJBException,
                           EngineEverybodyWorkItemException,
                           EngineLastAdminWorkItemException,
                           EngineNotAuthorizedException,
                           EngineParameterNullException,
                           EngineWrongKindException,
                           EngineWrongStateException,
                           IdWrongFormatException,
                           InvalidLengthException,
                           MethodNotApplicableException,
                           ObjectDoesNotExistException,
                           WorkItemManagerException,
                           UnexpectedFailureException
Deletes the specified work item for the specified BPEL 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.

Parameters:
piid - 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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineEverybodyWorkItemException
EngineLastAdminWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
MethodNotApplicableException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
Since:
5.1

deleteWorkItem

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

Following restrictions apply:

The caller must be an administrator of the process instance.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineEverybodyWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessReaderWorkItemException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
MethodNotApplicableException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
Since:
5.1

transferWorkItem

public void transferWorkItem(java.lang.String identifier,
                             int assignmentReason,
                             java.lang.String fromUserID,
                             java.lang.String toUserID)
                      throws java.rmi.RemoteException,
                             javax.ejb.EJBException,
                             EngineEverybodyWorkItemException,
                             EngineNotAuthorizedException,
                             EngineParameterNullException,
                             EngineProcessReaderWorkItemException,
                             EngineWrongKindException,
                             EngineWrongStateException,
                             IdWrongFormatException,
                             IdWrongTypeException,
                             InvalidLengthException,
                             MethodNotApplicableException,
                             ObjectDoesNotExistException,
                             WorkItemManagerException,
                             UnexpectedFailureException
Transfers the specified work item of a BPEL process 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineEverybodyWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessReaderWorkItemException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
MethodNotApplicableException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
Since:
5.1

transferWorkItem

public void transferWorkItem(PIID piid,
                             int assignmentReason,
                             java.lang.String fromUserID,
                             java.lang.String toUserID)
                      throws java.rmi.RemoteException,
                             javax.ejb.EJBException,
                             EngineEverybodyWorkItemException,
                             EngineNotAuthorizedException,
                             EngineParameterNullException,
                             EngineWrongKindException,
                             EngineWrongStateException,
                             IdWrongFormatException,
                             InvalidLengthException,
                             MethodNotApplicableException,
                             ObjectDoesNotExistException,
                             WorkItemManagerException,
                             UnexpectedFailureException
Transfers a work item for the specified BPEL 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineEverybodyWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
MethodNotApplicableException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
Since:
5.1

transferWorkItem

public void transferWorkItem(AIID aiid,
                             int assignmentReason,
                             java.lang.String fromUserID,
                             java.lang.String toUserID)
                      throws java.rmi.RemoteException,
                             javax.ejb.EJBException,
                             EngineEverybodyWorkItemException,
                             EngineNotAuthorizedException,
                             EngineParameterNullException,
                             EngineProcessReaderWorkItemException,
                             EngineWrongKindException,
                             EngineWrongStateException,
                             IdWrongFormatException,
                             InvalidLengthException,
                             MethodNotApplicableException,
                             ObjectDoesNotExistException,
                             WorkItemManagerException,
                             UnexpectedFailureException
Transfers a work item for the specified BPEL 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineEverybodyWorkItemException
EngineNotAuthorizedException
EngineParameterNullException
EngineProcessReaderWorkItemException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
MethodNotApplicableException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
Since:
5.1

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 java.rmi.RemoteException,
                        javax.ejb.EJBException,
                        EngineNotAuthorizedException,
                        InvalidLengthException,
                        UnexpectedFailureException
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.

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 produced when the worklist is executed. It represents 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(), COUNT(), 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.

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.

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".

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.

threshold - The maximum number of worklist execution result tuples to be returned. 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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineNotAuthorizedException
InvalidLengthException
UnexpectedFailureException
Since:
5.0

getWorkListNames

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

Returns:
String[] - An array of worklist names. If there are no worklists defined, an empty array is returned.

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

deleteWorkList

public void deleteWorkList(java.lang.String workListName)
                    throws java.rmi.RemoteException,
                           javax.ejb.EJBException,
                           EngineNotAuthorizedException,
                           UnexpectedFailureException
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.

Parameters:
workListName - The name of the worklist to be deleted - refer to getWorkListNames for the retrieval of existing worklist names.

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

getWorkList

public WorkListData getWorkList(java.lang.String workListName)
                         throws java.rmi.RemoteException,
                                javax.ejb.EJBException,
                                UnexpectedFailureException
Retrieves the specified worklist definition.

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:
java.rmi.RemoteException
javax.ejb.EJBException
UnexpectedFailureException
Since:
5.0

executeWorkList

public QueryResultSet executeWorkList(java.lang.String workListName)
                               throws java.rmi.RemoteException,
                                      javax.ejb.EJBException,
                                      IdWrongFormatException,
                                      ObjectDoesNotExistException,
                                      QueryInvalidOperandException,
                                      QueryInvalidTimestampException,
                                      QueryUndefinedParameterException,
                                      QueryUnknownColumnException,
                                      QueryUnknownOperatorException,
                                      QueryUnknownTableException,
                                      UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
IdWrongFormatException
ObjectDoesNotExistException
QueryInvalidOperandException
QueryInvalidTimestampException
QueryUndefinedParameterException
QueryUnknownColumnException
QueryUnknownOperatorException
QueryUnknownTableException
UnexpectedFailureException
Since:
5.0

getWorkItems

public WorkItemData[] getWorkItems(java.lang.String identifier)
                            throws java.rmi.RemoteException,
                                   javax.ejb.EJBException,
                                   IdWrongFormatException,
                                   IdWrongTypeException,
                                   WorkItemManagerException,
                                   UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
IdWrongFormatException
IdWrongTypeException
WorkItemManagerException
UnexpectedFailureException
Since:
5.0

getWorkItems

public WorkItemData[] getWorkItems(AIID aiid)
                            throws java.rmi.RemoteException,
                                   javax.ejb.EJBException,
                                   IdWrongFormatException,
                                   WorkItemManagerException,
                                   UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
IdWrongFormatException
WorkItemManagerException
UnexpectedFailureException
Since:
5.1

getWorkItems

public WorkItemData[] getWorkItems(PIID piid)
                            throws java.rmi.RemoteException,
                                   javax.ejb.EJBException,
                                   IdWrongFormatException,
                                   WorkItemManagerException,
                                   UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
IdWrongFormatException
WorkItemManagerException
UnexpectedFailureException
Since:
5.1

refreshStaffQuery

public void refreshStaffQuery()
                       throws java.rmi.RemoteException,
                              javax.ejb.EJBException,
                              EngineNotAuthorizedException,
                              WorkItemManagerException,
                              UnexpectedFailureException
Deprecated.  

For future use.

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

refreshStaffQuery

public void refreshStaffQuery(java.lang.String identifier)
                       throws java.rmi.RemoteException,
                              javax.ejb.EJBException,
                              EngineNotAuthorizedException,
                              WorkItemManagerException,
                              IdWrongFormatException,
                              IdWrongTypeException,
                              UnexpectedFailureException
Deprecated.  

For future use.

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

refreshStaffQuery

public void refreshStaffQuery(PTID ptid)
                       throws java.rmi.RemoteException,
                              javax.ejb.EJBException,
                              EngineNotAuthorizedException,
                              WorkItemManagerException,
                              UnexpectedFailureException
Deprecated.  

For future use.

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

refreshStaffQuery

public void refreshStaffQuery(AIID aiid)
                       throws java.rmi.RemoteException,
                              javax.ejb.EJBException,
                              EngineNotAuthorizedException,
                              WorkItemManagerException,
                              UnexpectedFailureException
Deprecated.  

For future use.

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

refreshStaffQuery

public void refreshStaffQuery(PIID piid)
                       throws java.rmi.RemoteException,
                              javax.ejb.EJBException,
                              EngineNotAuthorizedException,
                              WorkItemManagerException,
                              UnexpectedFailureException
Deprecated.  

For future use.

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

sendEvent

public void sendEvent(java.lang.String identifier,
                      java.lang.String eventName,
                      ClientObjectWrapper inputMessage)
               throws java.rmi.RemoteException,
                      javax.ejb.EJBException,
                      EngineAuthorizationPluginException,
                      EngineCannotInitializePluginException,
                      EngineDataMappingException,
                      EngineDataPluginException,
                      EngineEventNotKnownException,
                      EngineExitConditionEvaluationException,
                      EngineFaultHasBeenNavigatedException,
                      EngineLoopConditionEvaluationException,
                      EngineLoopMappingException,
                      EngineMaxNumberLoopIterationsExceededException,
                      EngineMaxNumberRetryExceededException,
                      EngineNotAuthorizedException,
                      EngineParameterNullException,
                      EngineUncaughtExceptionInProcessException,
                      EngineWrongMessageTypeException,
                      EngineWrongStateException,
                      IdAndCorrelationSetMismatchException,
                      IdWrongTypeException,
                      InvalidLengthException,
                      MissingPartsException,
                      ObjectDoesNotExistException,
                      ProcessException,
                      ProcessInstanceNotUniqueException,
                      UnexpectedFailureException
Deprecated. For BPEL processes replaced by sendMessage(java.lang.String, java.lang.String, com.ibm.bpe.api.ClientObjectWrapper).

Sends the specified event to the specified process instance using the string representation of the process instance ID or the process instance name.

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

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 receive the event.
eventName - The name of the event sent.
inputMessage - The input message for the event. The object wrapped by the ClientObjectWrapper must be serializable.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineAuthorizationPluginException
EngineCannotInitializePluginException
EngineDataMappingException
EngineDataPluginException
EngineEventNotKnownException
EngineExitConditionEvaluationException
EngineFaultHasBeenNavigatedException
EngineLoopConditionEvaluationException
EngineLoopMappingException
EngineMaxNumberLoopIterationsExceededException
EngineMaxNumberRetryExceededException
EngineNotAuthorizedException
EngineParameterNullException
EngineUncaughtExceptionInProcessException
EngineWrongMessageTypeException
EngineWrongStateException
IdAndCorrelationSetMismatchException
IdWrongTypeException
InvalidLengthException
MissingPartsException
ObjectDoesNotExistException
ProcessException
ProcessInstanceNotUniqueException
UnexpectedFailureException
Since:
5.1

sendEvent

public void sendEvent(PIID piid,
                      java.lang.String eventName,
                      ClientObjectWrapper inputMessage)
               throws java.rmi.RemoteException,
                      javax.ejb.EJBException,
                      EngineAuthorizationPluginException,
                      EngineCannotInitializePluginException,
                      EngineDataMappingException,
                      EngineDataPluginException,
                      EngineEventNotKnownException,
                      EngineExitConditionEvaluationException,
                      EngineFaultHasBeenNavigatedException,
                      EngineLoopConditionEvaluationException,
                      EngineLoopMappingException,
                      EngineMaxNumberLoopIterationsExceededException,
                      EngineMaxNumberRetryExceededException,
                      EngineNotAuthorizedException,
                      EngineParameterNullException,
                      EngineUncaughtExceptionInProcessException,
                      EngineWrongMessageTypeException,
                      EngineWrongStateException,
                      IdAndCorrelationSetMismatchException,
                      IdWrongFormatException,
                      InvalidLengthException,
                      MissingPartsException,
                      ObjectDoesNotExistException,
                      ProcessException,
                      ProcessInstanceNotUniqueException,
                      UnexpectedFailureException
Deprecated. For BPEL processes replaced by sendMessage(java.lang.String, java.lang.String, com.ibm.bpe.api.ClientObjectWrapper).

Sends the specified event to the specified process instance using the process instance ID.

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

Parameters:
piid - The object ID of the process instance that is to receive the event.
eventName - The name of the event sent.
inputMessage - The input message for the event. The object wrapped by the ClientObjectWrapper must be serializable.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineAuthorizationPluginException
EngineCannotInitializePluginException
EngineDataMappingException
EngineDataPluginException
EngineEventNotKnownException
EngineExitConditionEvaluationException
EngineFaultHasBeenNavigatedException
EngineLoopConditionEvaluationException
EngineLoopMappingException
EngineMaxNumberLoopIterationsExceededException
EngineMaxNumberRetryExceededException
EngineNotAuthorizedException
EngineParameterNullException
EngineUncaughtExceptionInProcessException
EngineWrongMessageTypeException
EngineWrongStateException
IdAndCorrelationSetMismatchException
IdWrongFormatException
InvalidLengthException
MissingPartsException
ObjectDoesNotExistException
ProcessException
ProcessInstanceNotUniqueException
UnexpectedFailureException
Since:
5.1

forceRetry

public void forceRetry(AIID aiid,
                       boolean continueOnError)
                throws java.rmi.RemoteException,
                       javax.ejb.EJBException,
                       EngineCannotInitializePluginException,
                       EngineDataPluginException,
                       EngineFaultHasBeenNavigatedException,
                       EngineNotAuthorizedException,
                       EngineUncaughtExceptionInProcessException,
                       EngineWrongKindException,
                       EngineWrongMessageTypeException,
                       EngineWrongStateException,
                       IdWrongFormatException,
                       InvalidLengthException,
                       ObjectDoesNotExistException,
                       UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
EngineNotAuthorizedException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

forceRetry

public void forceRetry(java.lang.String aiid,
                       boolean continueOnError)
                throws java.rmi.RemoteException,
                       javax.ejb.EJBException,
                       EngineCannotInitializePluginException,
                       EngineDataPluginException,
                       EngineFaultHasBeenNavigatedException,
                       EngineNotAuthorizedException,
                       EngineUncaughtExceptionInProcessException,
                       EngineWrongKindException,
                       EngineWrongMessageTypeException,
                       EngineWrongStateException,
                       IdWrongFormatException,
                       IdWrongTypeException,
                       InvalidLengthException,
                       ObjectDoesNotExistException,
                       UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
EngineNotAuthorizedException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.0

forceRetry

public void forceRetry(AIID aiid,
                       ClientObjectWrapper inputMessage,
                       boolean continueOnError)
                throws java.rmi.RemoteException,
                       javax.ejb.EJBException,
                       EngineCannotInitializePluginException,
                       EngineDataPluginException,
                       EngineFaultHasBeenNavigatedException,
                       EngineNotAuthorizedException,
                       EngineUncaughtExceptionInProcessException,
                       EngineWrongKindException,
                       EngineWrongMessageTypeException,
                       EngineWrongStateException,
                       IdWrongFormatException,
                       InvalidLengthException,
                       ObjectDoesNotExistException,
                       UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
EngineNotAuthorizedException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

forceRetry

public void forceRetry(java.lang.String aiid,
                       ClientObjectWrapper inputMessage,
                       boolean continueOnError)
                throws java.rmi.RemoteException,
                       javax.ejb.EJBException,
                       EngineCannotInitializePluginException,
                       EngineDataPluginException,
                       EngineFaultHasBeenNavigatedException,
                       EngineNotAuthorizedException,
                       EngineUncaughtExceptionInProcessException,
                       EngineWrongKindException,
                       EngineWrongMessageTypeException,
                       EngineWrongStateException,
                       IdWrongFormatException,
                       IdWrongTypeException,
                       InvalidLengthException,
                       ObjectDoesNotExistException,
                       UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
EngineNotAuthorizedException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.0

forceComplete

public void forceComplete(AIID aiid,
                          boolean continueOnError)
                   throws java.rmi.RemoteException,
                          javax.ejb.EJBException,
                          EngineCannotInitializePluginException,
                          EngineFaultHasBeenNavigatedException,
                          EngineNotAuthorizedException,
                          EngineUncaughtExceptionInProcessException,
                          EngineWrongKindException,
                          EngineWrongStateException,
                          IdWrongFormatException,
                          InvalidLengthException,
                          ObjectDoesNotExistException,
                          UnexpectedFailureException
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. Schema 5.0 exit and loop conditions are not checked.

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: an output or fault message does not need to be set; navigation can continue with an empty output message.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineFaultHasBeenNavigatedException
EngineNotAuthorizedException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

forceComplete

public void forceComplete(java.lang.String aiid,
                          boolean continueOnError)
                   throws java.rmi.RemoteException,
                          javax.ejb.EJBException,
                          EngineCannotInitializePluginException,
                          EngineFaultHasBeenNavigatedException,
                          EngineNotAuthorizedException,
                          EngineUncaughtExceptionInProcessException,
                          EngineWrongKindException,
                          EngineWrongStateException,
                          IdWrongFormatException,
                          IdWrongTypeException,
                          InvalidLengthException,
                          ObjectDoesNotExistException,
                          UnexpectedFailureException
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. Schema 5.0 exit and loop conditions are not checked.

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: an output or fault message does not need to be set; navigation can continue with an empty output message.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineFaultHasBeenNavigatedException
EngineNotAuthorizedException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.0

forceComplete

public void forceComplete(AIID aiid,
                          ClientObjectWrapper output,
                          boolean continueOnError)
                   throws java.rmi.RemoteException,
                          javax.ejb.EJBException,
                          EngineCannotInitializePluginException,
                          EngineDataPluginException,
                          EngineFaultHasBeenNavigatedException,
                          EngineInvalidFaultTerminalException,
                          EngineNotAuthorizedException,
                          EngineParameterNullException,
                          EngineUncaughtExceptionInProcessException,
                          EngineWrongKindException,
                          EngineWrongMessageTypeException,
                          EngineWrongStateException,
                          IdWrongFormatException,
                          InvalidLengthException,
                          ObjectDoesNotExistException,
                          UnexpectedFailureException
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. Schema 5.0 exit and loop conditions are not checked.

Output message values are used to continue navigation.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
EngineInvalidFaultTerminalException
EngineNotAuthorizedException
EngineParameterNullException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

forceComplete

public void forceComplete(java.lang.String aiid,
                          ClientObjectWrapper output,
                          boolean continueOnError)
                   throws java.rmi.RemoteException,
                          javax.ejb.EJBException,
                          EngineCannotInitializePluginException,
                          EngineDataPluginException,
                          EngineFaultHasBeenNavigatedException,
                          EngineInvalidFaultTerminalException,
                          EngineNotAuthorizedException,
                          EngineParameterNullException,
                          EngineUncaughtExceptionInProcessException,
                          EngineWrongKindException,
                          EngineWrongMessageTypeException,
                          EngineWrongStateException,
                          IdWrongFormatException,
                          IdWrongTypeException,
                          InvalidLengthException,
                          ObjectDoesNotExistException,
                          UnexpectedFailureException
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. Schema 5.0 exit and loop conditions are not checked.

Output message values are used to continue navigation.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
EngineInvalidFaultTerminalException
EngineNotAuthorizedException
EngineParameterNullException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.0

forceComplete

public void forceComplete(AIID aiid,
                          ClientObjectWrapper message,
                          java.lang.String faultName,
                          boolean continueOnError)
                   throws java.rmi.RemoteException,
                          javax.ejb.EJBException,
                          EngineCannotInitializePluginException,
                          EngineDataPluginException,
                          EngineFaultHasBeenNavigatedException,
                          EngineInvalidFaultTerminalException,
                          EngineNotAuthorizedException,
                          EngineParameterNullException,
                          EngineUncaughtExceptionInProcessException,
                          EngineWrongKindException,
                          EngineWrongMessageTypeException,
                          EngineWrongStateException,
                          IdWrongFormatException,
                          InvalidLengthException,
                          ObjectDoesNotExistException,
                          UnexpectedFailureException
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. Schema 5.0 exit and loop conditions are not checked.

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.

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. Can also specify an output terminal for version 5.0 activities. 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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
EngineInvalidFaultTerminalException
EngineNotAuthorizedException
EngineParameterNullException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

forceComplete

public void forceComplete(java.lang.String aiid,
                          ClientObjectWrapper message,
                          java.lang.String faultName,
                          boolean continueOnError)
                   throws java.rmi.RemoteException,
                          javax.ejb.EJBException,
                          EngineCannotInitializePluginException,
                          EngineDataPluginException,
                          EngineFaultHasBeenNavigatedException,
                          EngineInvalidFaultTerminalException,
                          EngineNotAuthorizedException,
                          EngineParameterNullException,
                          EngineUncaughtExceptionInProcessException,
                          EngineWrongKindException,
                          EngineWrongMessageTypeException,
                          EngineWrongStateException,
                          IdWrongFormatException,
                          IdWrongTypeException,
                          InvalidLengthException,
                          ObjectDoesNotExistException,
                          UnexpectedFailureException
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. Schema 5.0 exit and loop conditions are not checked.

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.

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. Can also specify an output terminal for version 5.0 activities. 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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineDataPluginException
EngineFaultHasBeenNavigatedException
EngineInvalidFaultTerminalException
EngineNotAuthorizedException
EngineParameterNullException
EngineUncaughtExceptionInProcessException
EngineWrongKindException
EngineWrongMessageTypeException
EngineWrongStateException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.0

getAllActivities

public QueryResultSet getAllActivities(java.lang.String piid,
                                       java.util.TimeZone timezone)
                                throws java.rmi.RemoteException,
                                       javax.ejb.EJBException,
                                       EngineCannotInitializePluginException,
                                       EngineNotAuthorizedException,
                                       IdWrongFormatException,
                                       IdWrongTypeException,
                                       ObjectDoesNotExistException,
                                       WorkItemManagerException,
                                       UnexpectedFailureException
Queries pre-defined activity instance properties of activities directly contained in the specified process instance or block instance using a string representation of the process or block 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: For a BPEL process, 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.

Parameters:
piid - The String representation of the object ID of the process or schema 5.0 block 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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineNotAuthorizedException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
Since:
5.0

getAllActivities

public QueryResultSet getAllActivities(PIID piid,
                                       java.util.TimeZone timezone)
                                throws java.rmi.RemoteException,
                                       javax.ejb.EJBException,
                                       EngineCannotInitializePluginException,
                                       EngineNotAuthorizedException,
                                       IdWrongFormatException,
                                       ObjectDoesNotExistException,
                                       WorkItemManagerException,
                                       UnexpectedFailureException
Queries pre-defined activity instance properties of activities directly contained in the specified process instance or block instance using the process or block 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: For a BPEL process, 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.

Parameters:
piid - The object ID of the process instance or schema 5.0 block 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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineNotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
Since:
5.1

getAllWorkItems

public WorkItemData[] getAllWorkItems(java.lang.String identifier)
                               throws java.rmi.RemoteException,
                                      javax.ejb.EJBException,
                                      EngineCannotInitializePluginException,
                                      EngineNotAuthorizedException,
                                      EngineWrongKindException,
                                      IdWrongFormatException,
                                      IdWrongTypeException,
                                      ObjectDoesNotExistException,
                                      WorkItemManagerException,
                                      UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineNotAuthorizedException
EngineWrongKindException
IdWrongFormatException
IdWrongTypeException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
Since:
5.0

getAllWorkItems

public WorkItemData[] getAllWorkItems(PIID piid)
                               throws java.rmi.RemoteException,
                                      javax.ejb.EJBException,
                                      EngineCannotInitializePluginException,
                                      EngineNotAuthorizedException,
                                      IdWrongFormatException,
                                      ObjectDoesNotExistException,
                                      WorkItemManagerException,
                                      UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineNotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
Since:
5.1

getAllWorkItems

public WorkItemData[] getAllWorkItems(AIID aiid)
                               throws java.rmi.RemoteException,
                                      javax.ejb.EJBException,
                                      EngineCannotInitializePluginException,
                                      EngineNotAuthorizedException,
                                      EngineWrongKindException,
                                      IdWrongFormatException,
                                      ObjectDoesNotExistException,
                                      WorkItemManagerException,
                                      UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineCannotInitializePluginException
EngineNotAuthorizedException
EngineWrongKindException
IdWrongFormatException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
Since:
5.1

getWorkListActions

public int[] getWorkListActions()
                         throws java.rmi.RemoteException,
                                javax.ejb.EJBException
Returns the actions that can be called by the logged-on user related to worklists.

Returns:
int[] - An array of worklist actions. Refer to WorkListActions for the set of available actions.
Throws:
java.rmi.RemoteException
javax.ejb.EJBException

getStartActivities

public ActivityServiceTemplateData[] getStartActivities(java.lang.String ptid)
                                                 throws java.rmi.RemoteException,
                                                        javax.ejb.EJBException,
                                                        EngineNotAuthorizedException,
                                                        IdWrongFormatException,
                                                        IdWrongTypeException,
                                                        MethodNotApplicableException,
                                                        ObjectDoesNotExistException,
                                                        UnexpectedFailureException
Returns information about activities that can start a BPEL 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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineNotAuthorizedException
IdWrongFormatException
IdWrongTypeException
MethodNotApplicableException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

getStartActivities

public ActivityServiceTemplateData[] getStartActivities(PTID ptid)
                                                 throws java.rmi.RemoteException,
                                                        javax.ejb.EJBException,
                                                        EngineNotAuthorizedException,
                                                        MethodNotApplicableException,
                                                        ObjectDoesNotExistException,
                                                        UnexpectedFailureException
Returns information about activities that can start a BPEL process instance from the specified process template using the process template ID.

The caller must be authorized for the process template.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineNotAuthorizedException
MethodNotApplicableException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1

sendMessage

public PIID sendMessage(java.lang.String vtid,
                        java.lang.String atid,
                        ClientObjectWrapper message)
                 throws java.rmi.RemoteException,
                        javax.ejb.EJBException,
                        CreateFailedException,
                        EngineNotAuthorizedException,
                        EngineProcessModelStoppedException,
                        FaultReplyException,
                        IdWrongFormatException,
                        IdWrongTypeException,
                        MissingPartsException,
                        ObjectDoesNotExistException,
                        ProcessException,
                        ProcessInstanceNotUniqueException,
                        UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
CreateFailedException
EngineNotAuthorizedException
EngineProcessModelStoppedException
FaultReplyException
IdWrongFormatException
IdWrongTypeException
MissingPartsException
ObjectDoesNotExistException
ProcessException
ProcessInstanceNotUniqueException
UnexpectedFailureException
Since:
5.1.1

sendMessage

public PIID sendMessage(VTID vtid,
                        ATID atid,
                        ClientObjectWrapper message)
                 throws java.rmi.RemoteException,
                        javax.ejb.EJBException,
                        CreateFailedException,
                        EngineNotAuthorizedException,
                        EngineProcessModelStoppedException,
                        FaultReplyException,
                        IdWrongFormatException,
                        MissingPartsException,
                        ObjectDoesNotExistException,
                        ProcessException,
                        ProcessInstanceNotUniqueException,
                        UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
CreateFailedException
EngineNotAuthorizedException
EngineProcessModelStoppedException
FaultReplyException
IdWrongFormatException
MissingPartsException
ObjectDoesNotExistException
ProcessException
ProcessInstanceNotUniqueException
UnexpectedFailureException
Since:
5.1.1

sendMessage

public void sendMessage(java.lang.String piid,
                        java.lang.String vtid,
                        java.lang.String atid,
                        ClientObjectWrapper message)
                 throws java.rmi.RemoteException,
                        javax.ejb.EJBException,
                        EngineNotAuthorizedException,
                        IdAndCorrelationSetMismatchException,
                        IdWrongFormatException,
                        IdWrongTypeException,
                        MissingPartsException,
                        ObjectDoesNotExistException,
                        ProcessException,
                        ProcessInstanceNotUniqueException,
                        UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineNotAuthorizedException
IdAndCorrelationSetMismatchException
IdWrongFormatException
IdWrongTypeException
MissingPartsException
ObjectDoesNotExistException
ProcessException
ProcessInstanceNotUniqueException
UnexpectedFailureException
Since:
5.1

sendMessage

public void sendMessage(PIID piid,
                        VTID vtid,
                        ATID atid,
                        ClientObjectWrapper message)
                 throws java.rmi.RemoteException,
                        javax.ejb.EJBException,
                        EngineNotAuthorizedException,
                        IdAndCorrelationSetMismatchException,
                        IdWrongFormatException,
                        MissingPartsException,
                        ObjectDoesNotExistException,
                        ProcessException,
                        ProcessInstanceNotUniqueException,
                        UnexpectedFailureException
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.

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:
java.rmi.RemoteException
javax.ejb.EJBException
EngineNotAuthorizedException
IdAndCorrelationSetMismatchException
IdWrongFormatException
MissingPartsException
ObjectDoesNotExistException
ProcessException
ProcessInstanceNotUniqueException
UnexpectedFailureException
Since:
5.1

getActivityServiceTemplate

public ActivityServiceTemplateData getActivityServiceTemplate(java.lang.String vtid,
                                                              java.lang.String atid)
                                                       throws java.rmi.RemoteException,
                                                              javax.ejb.EJBException,
                                                              EngineNotAuthorizedException,
                                                              IdWrongFormatException,
                                                              IdWrongTypeException,
                                                              ObjectDoesNotExistException,
                                                              UnexpectedFailureException
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.

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. If not found, null is returned. Refer to ActivityServiceTemplateData to view the properties of an activity service template.

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

getActivityServiceTemplate

public ActivityServiceTemplateData getActivityServiceTemplate(VTID vtid,
                                                              ATID atid)
                                                       throws java.rmi.RemoteException,
                                                              javax.ejb.EJBException,
                                                              EngineNotAuthorizedException,
                                                              IdWrongFormatException,
                                                              ObjectDoesNotExistException,
                                                              UnexpectedFailureException
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.

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. If not found, null is returned. Refer to ActivityServiceTemplateData to view the properties of an activity service template.

Throws:
java.rmi.RemoteException
javax.ejb.EJBException
EngineNotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
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.

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 administrator. A business process administrator has all priviledges.

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

getClientUISettings

public CustomClientSettings getClientUISettings(java.lang.String identifier)
                                         throws java.rmi.RemoteException,
                                                javax.ejb.EJBException,
                                                EngineNotAuthorizedException,
                                                EngineWrongKindException,
                                                IdWrongFormatException,
                                                IdWrongTypeException,
                                                MethodNotApplicableException,
                                                ObjectDoesNotExistException,
                                                ServiceNotUniqueException,
                                                UnexpectedFailureException
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.

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 when there are no custom client settings.

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

getClientUISettings

public CustomClientSettings getClientUISettings(PTID ptid)
                                         throws java.rmi.RemoteException,
                                                javax.ejb.EJBException,
                                                EngineNotAuthorizedException,
                                                IdWrongFormatException,
                                                MethodNotApplicableException,
                                                ObjectDoesNotExistException,
                                                UnexpectedFailureException
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.

Parameters:
ptid - The object ID of the process template.

Returns:
CustomClientSettings - The customized client interface settings. Returns null when there are no custom client settings.

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

getClientUISettings

public CustomClientSettings getClientUISettings(PIID piid)
                                         throws java.rmi.RemoteException,
                                                javax.ejb.EJBException,
                                                EngineNotAuthorizedException,
                                                IdWrongFormatException,
                                                MethodNotApplicableException,
                                                ObjectDoesNotExistException,
                                                UnexpectedFailureException
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.

Parameters:
piid - The object ID of the process instance.

Returns:
CustomClientSettings - The customized client interface settings. Returns null when there are no custom client settings.

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

getClientUISettings

public CustomClientSettings getClientUISettings(AIID aiid)
                                         throws java.rmi.RemoteException,
                                                javax.ejb.EJBException,
                                                EngineNotAuthorizedException,
                                                EngineWrongKindException,
                                                IdWrongFormatException,
                                                MethodNotApplicableException,
                                                ObjectDoesNotExistException,
                                                ServiceNotUniqueException,
                                                UnexpectedFailureException
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.

Parameters:
aiid - The object ID of the activity instance.

Returns:
CustomClientSettings - The customized client interface settings. Returns null when there are no custom client settings.

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

getClientUISettings

public CustomClientSettings getClientUISettings(java.lang.String vtid,
                                                java.lang.String atid)
                                         throws java.rmi.RemoteException,
                                                javax.ejb.EJBException,
                                                EngineNotAuthorizedException,
                                                IdWrongFormatException,
                                                IdWrongTypeException,
                                                ObjectDoesNotExistException,
                                                UnexpectedFailureException
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.

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 when there are no custom client settings.

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

getClientUISettings

public CustomClientSettings getClientUISettings(VTID vtid,
                                                ATID atid)
                                         throws java.rmi.RemoteException,
                                                javax.ejb.EJBException,
                                                EngineNotAuthorizedException,
                                                IdWrongFormatException,
                                                ObjectDoesNotExistException,
                                                UnexpectedFailureException
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.

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 when there are no custom client settings.

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

getInputClientUISettings

public CustomClientSettings getInputClientUISettings(java.lang.String piid)
                                              throws java.rmi.RemoteException,
                                                     javax.ejb.EJBException,
                                                     EngineNotAuthorizedException,
                                                     IdWrongFormatException,
                                                     IdWrongTypeException,
                                                     MethodNotApplicableException,
                                                     ObjectDoesNotExistException,
                                                     UnexpectedFailureException
Retrieves client interface settings for the input message of the specified process instance using 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.

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.

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

getInputClientUISettings

public CustomClientSettings getInputClientUISettings(PIID piid)
                                              throws java.rmi.RemoteException,
                                                     javax.ejb.EJBException,
                                                     EngineNotAuthorizedException,
                                                     IdWrongFormatException,
                                                     MethodNotApplicableException,
                                                     ObjectDoesNotExistException,
                                                     UnexpectedFailureException
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.

Parameters:
piid - The object ID of the process instance.

Returns:
CustomClientSettings - The customized client interface settings of the input message.

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

getOutputClientUISettings

public CustomClientSettings getOutputClientUISettings(java.lang.String piid)
                                               throws java.rmi.RemoteException,
                                                      javax.ejb.EJBException,
                                                      EngineNotAuthorizedException,
                                                      IdWrongFormatException,
                                                      IdWrongTypeException,
                                                      MethodNotApplicableException,
                                                      ObjectDoesNotExistException,
                                                      UnexpectedFailureException
Retrieves client interface settings for the output message of the specified process instance using 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.

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.

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

getOutputClientUISettings

public CustomClientSettings getOutputClientUISettings(PIID piid)
                                               throws java.rmi.RemoteException,
                                                      javax.ejb.EJBException,
                                                      EngineNotAuthorizedException,
                                                      IdWrongFormatException,
                                                      MethodNotApplicableException,
                                                      ObjectDoesNotExistException,
                                                      UnexpectedFailureException
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.

Parameters:
piid - The object ID of the process instance.

Returns:
CustomClientSettings - The customized client interface settings of the output message.

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