com.ibm.task.api

Interface HumanTaskManagerService

    • Field Summary

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

      Methods 
      Modifier and Type Method and Description
      java.util.List bulkTransferWorkItem(ESIID[] esiids, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner)
      Transfers the specified work items for the specified escalation instances using escalation instance IDs - each transfer operation is executed in a transaction on its own.
      java.util.List bulkTransferWorkItem(java.lang.String[] identifiers, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner)
      Transfers the specified work items for the specified escalation or task instances using escalation or task instance IDs - each transfer operation is executed in a transaction on its own.
      java.util.List bulkTransferWorkItem(TKIID[] tkiids, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner)
      Transfers the specified work items for the specified task instances using task instance IDs - each transfer operation is executed in a transaction on its own.
      ClientObjectWrapper callTask(java.lang.String tkiid, ClientObjectWrapper input)
      Synchronously executes a previously created invocation task instance using a string representation of the task instance ID.
      ClientObjectWrapper callTask(TKIID tkiid, ClientObjectWrapper input)
      Synchronously executes a previously created invocation task instance using the task instance ID.
      void cancelClaim(java.lang.String tkiid)
      Cancels the claim of a task instance using a string representation of the task instance ID.
      java.util.List cancelClaim(java.lang.String[] identifiers)
      Cancels the claim of the specified task instances using string representations of the task instance IDs.
      void cancelClaim(java.lang.String tkiid, boolean keepTaskData)
      Cancels the claim of a task instance and keeps any data that has been set using a string representation of the task instance ID.
      void cancelClaim(TKIID tkiid)
      Cancels the claim of a task instance using the task instance ID.
      java.util.List cancelClaim(TKIID[] tkiids)
      Cancels the claim of the specified task instances using task instance IDs.
      void cancelClaim(TKIID tkiid, boolean keepTaskData)
      Cancels the claim of a task instance and keeps any data that has been set using the task instance ID.
      ClientObjectWrapper claim(java.lang.String tkiid)
      Claims a ready to-do or collaboration task instance for user processing using a string representation of the task instance ID.
      java.util.List claim(java.lang.String[] identifiers)
      Claims ready to-do or collaboration task instances for user processing using string representations of task instance IDs.
      ClaimResult claim(java.lang.String queryTableName, FilterOptions filterOptions, AuthorizationOptions authorizationOptions, java.util.List parameters, int maxRetryCount)
      Claims a ready to-do or collaboration task instance contained in the specified query table.
      Task claim(java.lang.String whereClause, java.lang.String orderByClause, java.util.TimeZone timeZone)
      Claims some ready to-do or collaboration task instance for user processing.
      ClientObjectWrapper claim(TKIID tkiid)
      Claims a ready to-do or collaboration task instance for user processing using the task instance ID.
      java.util.List claim(TKIID[] tkiids)
      Claims ready to-do or collaboration task instances for user processing using task instance IDs.
      void complete(java.lang.String tkiid)
      Completes a claimed task instance using a string representation of the task instance ID.
      java.util.List complete(java.lang.String[] tkiids)
      Completes the specified task instances using string representations of the task instance IDs.
      void complete(java.lang.String tkiid, ClientObjectWrapper output)
      Completes a claimed task instance using a string representation of the task instance ID and passes the result of user processing.
      void complete(java.lang.String tkiid, java.lang.String faultName, ClientObjectWrapper faultMessage)
      Completes a claimed task instance using a string representation of the task instance ID and states the failing of user processing.
      void complete(TKIID tkiid)
      Completes a claimed task instance using the task instance ID.
      java.util.List complete(TKIID[] tkiids)
      Completes the specified task instances using task instance IDs.
      void complete(TKIID tkiid, ClientObjectWrapper output)
      Completes a claimed task instance using the task instance ID and passes the result of user processing.
      void complete(TKIID tkiid, java.lang.String faultName, ClientObjectWrapper faultMessage)
      Completes a claimed task instance using the task instance ID and states the failing of user processing.
      void completeWithFollowOnTask(java.lang.String tkiid, java.lang.String followOnID, ClientObjectWrapper input)
      Completes a task instance and starts a follow-on task using a string representation of the task instance ID.
      void completeWithFollowOnTask(TKIID tkiid, TKIID followOnID, ClientObjectWrapper input)
      Completes a task instance and starts a follow-on task using the task instance ID.
      void completeWithNewFollowOnTask(java.lang.String tkiid, java.lang.String name, java.lang.String namespace, ClientObjectWrapper input)
      Completes a task instance and creates and starts a follow-on task using a string representation of the task instance ID.
      void completeWithNewFollowOnTask(java.lang.String tkiid, TaskModel taskModel, java.lang.String applicationName, ClientObjectWrapper input)
      Completes a task instance and creates and starts an ad hoc follow-on task using a string representation of the task instance ID.
      void completeWithNewFollowOnTask(TKIID tkiid, java.lang.String name, java.lang.String namespace, ClientObjectWrapper input)
      Completes a task instance and creates and starts a follow-on task using the task instance ID.
      void completeWithNewFollowOnTask(TKIID tkiid, TaskModel taskModel, java.lang.String applicationName, ClientObjectWrapper input)
      Completes a task instance and creates and starts an ad hoc follow-on task using the task instance ID.
      ClientObjectWrapper createAndCallTask(java.lang.String tktid, ClientObjectWrapper input)
      Creates and synchronously executes an invocation task instance using a string representation of the task template ID.
      ClientObjectWrapper createAndCallTask(java.lang.String name, java.lang.String namespace, ClientObjectWrapper input)
      Creates and synchronously executes an invocation task instance.
      ClientObjectWrapper createAndCallTask(TKTID tktid, ClientObjectWrapper input)
      Creates and synchronously executes an invocation task instance using the task template ID.
      TKIID createAndStartTask(java.lang.String tktid, ClientObjectWrapper input, ReplyHandlerWrapper replyHandler)
      Creates and starts a task instance using a string representation of the task template ID.
      TKIID createAndStartTask(java.lang.String name, java.lang.String namespace, ClientObjectWrapper input, ReplyHandlerWrapper replyHandler)
      Creates and starts a task instance from the currently valid task template.
      TKIID createAndStartTask(TaskModel taskModel, java.lang.String applicationName, java.lang.String parentContext, ClientObjectWrapper input, ReplyHandlerWrapper replyHandler)
      Creates and starts a task from the specified task model.
      TKIID createAndStartTask(TKTID tktid, ClientObjectWrapper input, ReplyHandlerWrapper replyHandler)
      Creates and starts a task instance using the task template ID.
      TKIID createAndStartTaskAsSubTask(java.lang.String tktid, java.lang.String parentTaskID, ClientObjectWrapper input)
      Creates and starts a task instance as a subtask of the specified parent task instance using string representations of the task template and instance IDs.
      TKIID createAndStartTaskAsSubTask(java.lang.String name, java.lang.String namespace, java.lang.String parentTaskID, ClientObjectWrapper input)
      Creates and starts a task instance as a subtask of the specified parent task instance using a string representation of the parent task instance ID.
      TKIID createAndStartTaskAsSubTask(java.lang.String name, java.lang.String namespace, TKIID parentTaskID, ClientObjectWrapper input)
      Creates and starts a task instance as a subtask of the specified parent task instance using the parent task instance ID.
      TKIID createAndStartTaskAsSubTask(TaskModel taskModel, java.lang.String applicationName, java.lang.String parentTaskID, ClientObjectWrapper input)
      Creates and starts a task from the specified task model as a subtask of the specified parent task instance using a string representation of the task instance ID.
      TKIID createAndStartTaskAsSubTask(TaskModel taskModel, java.lang.String applicationName, TKIID parentTaskID, ClientObjectWrapper input)
      Creates and starts a task from the specified task model as a subtask of the specified parent task instance using the task instance ID.
      TKIID createAndStartTaskAsSubTask(TKTID tktid, TKIID parentTaskID, ClientObjectWrapper input)
      Creates and starts a task instance as a subtask of the specified parent task instance using task template and parent task instance IDs.
      ClientObjectWrapper createFaultMessage(java.lang.String identifier, java.lang.String faultName)
      Creates a fault message for a fault that is defined by the specified task instance or template using a string representation of the task instance or template ID.
      ClientObjectWrapper createFaultMessage(TKIID tkiid, java.lang.String faultName)
      Creates a fault message for a fault that is defined by the specified task instance using the task instance ID.
      ClientObjectWrapper createFaultMessage(TKTID tktid, java.lang.String faultName)
      Creates a fault message for a fault that is defined by the specified task template using the task template ID.
      ClientObjectWrapper createInputMessage(java.lang.String identifier)
      Creates an input message for the specified task instance or template using a string representation of the task instance or template ID.
      ClientObjectWrapper createInputMessage(TKIID tkiid)
      Creates an input message for the specified task instance using the task instance ID.
      ClientObjectWrapper createInputMessage(TKTID tktid)
      Creates an input message for the specified task template using the task template ID.
      ClientObjectWrapper createMessage(java.lang.String tkiid, java.lang.String messageTypeName)
      Deprecated. 
      As of version 6.0, replaced by createInputMessage, createOutputMessage, and createFaultMessage.
      ClientObjectWrapper createMessage(TKIID tkiid, java.lang.String messageTypeName)
      Deprecated. 
      As of version 6.0, replaced by createInputMessage, createOutputMessage, and createFaultMessage.
      ClientObjectWrapper createOutputMessage(java.lang.String identifier)
      Creates an output message for the specified task instance or template using a string representation of the task instance or template ID.
      ClientObjectWrapper createOutputMessage(TKIID tkiid)
      Creates an output message for the specified task instance using the task instance ID.
      ClientObjectWrapper createOutputMessage(TKTID tktid)
      Creates an output message for the specified task template using the task template ID.
      void createStoredQuery(java.lang.String storedQueryName, java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer threshold, java.util.TimeZone timeZone)
      Creates a query definition and persistently stores it in the database.
      void createStoredQuery(java.lang.String storedQueryName, java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer threshold, java.util.TimeZone timeZone, java.util.List storedQueryProperties, java.lang.String clientType)
      Creates a query definition and specifies properties to be stored together with the query.
      void createStoredQuery(java.lang.String userID, java.lang.String storedQueryName, java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer threshold, java.util.TimeZone timeZone, java.util.List storedQueryProperties, java.lang.String clientType)
      Creates a query definition for the specified user.
      TKIID createTask(java.lang.String tktid, ClientObjectWrapper input)
      Creates a task instance using a string representation of the task template ID and optionally passes an input message.
      TKIID createTask(java.lang.String name, java.lang.String namespace)
      Creates a task instance from the currently valid task template.
      TKIID createTask(java.lang.String name, java.lang.String namespace, ClientObjectWrapper input)
      Creates a task instance from the currently valid task template and specifies an input message.
      TKIID createTask(TaskModel taskModel, java.lang.String applicationName, java.lang.String parentContext)
      Creates a task instance from the specified task model.
      TKIID createTask(TaskModel taskModel, java.lang.String applicationName, java.lang.String parentContext, ClientObjectWrapper input)
      Creates a task instance from the specified task model and specifies an input message.
      TKIID createTask(TKTID tktid, ClientObjectWrapper input)
      Creates a task instance using the task template ID and optionally passes an input message.
      TKTID createTaskTemplate(TaskModel taskModel, java.lang.String applicationName)
      Creates a task template from the specified task model.
      void createWorkItem(ESIID esiid, int assignmentReason, java.lang.String userID)
      Creates a user work item for the specified escalation instance using the escalation instance ID.
      void createWorkItem(java.lang.String identifier, int assignmentReason, java.lang.String userID)
      Creates a user work item for the specified task or escalation instance using a string representation of the task or escalation instance ID.
      void createWorkItem(TKIID tkiid, int assignmentReason, java.lang.String userID)
      Creates a user work item for the specified task instance using the task instance ID.
      void delete(java.lang.String tkiid)
      Deletes the specified task instance using a string representation of the task instance ID.
      void delete(java.lang.String identifier, boolean deleteInstances)
      Deletes the specified task template using a string representation of the task template ID.
      void delete(TKIID tkiid)
      Deletes the specified task instance using the task instance ID.
      void delete(TKTID tktid, boolean deleteInstances)
      Deletes the specified task template using the task template ID.
      void deleteStoredQuery(java.lang.String storedQueryName)
      Deletes the specified stored query.
      void deleteStoredQuery(java.lang.String userID, java.lang.String storedQueryName)
      Deletes the specified stored query for the specified user.
      void deleteWorkItem(ESIID esiid, int assignmentReason, java.lang.String userID)
      Deletes the specified user work item using the escalation instance ID.
      void deleteWorkItem(java.lang.String identifier, int assignmentReason, java.lang.String userID)
      Deletes the specified user work item using a string representation of the task or escalation instance ID.
      void deleteWorkItem(TKIID tkiid, int assignmentReason, java.lang.String userID)
      Deletes the specified user work item using the task instance ID.
      java.util.List findQueryTableMetaData(MetaDataOptions metaDataOptions)
      Queries the meta data of query tables.
      boolean getAbsence()
      Deprecated. 
      As of version 7.0, replaced by getUserSubstitutionDetail.

      boolean getAbsence(java.lang.String userID)
      Deprecated. 
      As of version 7.0, replaced by getUserSubstitutionDetail.
      AIID getActivityID(java.lang.String tkiid)
      Retrieves the object ID of the activity instance associated to the specified task instance using a string representation of the task instance ID.
      AIID getActivityID(TKIID tkiid)
      Retrieves the object ID of the activity instance associated to the specified task instance using the task instance ID.
      java.util.List getAllCustomProperties(java.lang.String identifier)
      Retrieves all custom properties of the specified task template or task instance using a string representation of the object ID.
      java.util.List getAllCustomProperties(TKIID tkiid)
      Retrieves all custom properties of the specified task instance using the task instance ID.
      java.util.List getAllCustomProperties(TKTID tktid)
      Retrieves all custom properties of the specified task template using the task template ID.
      WorkItem[] getAllWorkItems(ESIID esiid)
      Returns all work item assignments associated to specified escalation instance using the escalation instance ID.
      WorkItem[] getAllWorkItems(java.lang.String identifier)
      Returns all work item assignments associated to specified task or escalation instance using a string representation of the task or escalation instance ID.
      WorkItem[] getAllWorkItems(TKIID tkiid)
      Returns all work item assignments associated to specified task instance using the task instance ID.
      ApplicationComponent getApplicationComponent(ACOID acoid)
      Retrieves the specified application component using the application component ID.
      ApplicationComponent getApplicationComponent(java.lang.String acoid)
      Retrieves the specified application component using a string representation of the application component ID.
      boolean[][] getAvailableActionFlags(ESIID[] esiids)
      Returns the actions that can be called for the specified escalation instances in their current state by the logged-on user using escalation instance IDs.
      boolean[][] getAvailableActionFlags(java.lang.String[] identifiers)
      Returns the actions that can be called for the specified tasks or escalations in their current state by the logged-on user using string representations of the task or escalation instance IDs.
      boolean[][] getAvailableActionFlags(TKIID[] tkiids)
      Returns the actions that can be called for the specified tasks in their current state by the logged-on user using task instance IDs.
      int[] getAvailableActions(ESIID esiid)
      Returns the actions that can be called in the current escalation instance state by the logged-on user using the escalation instance ID.
      int[] getAvailableActions(ESTID estid)
      Returns the actions that can be called in the current escalation template state by the logged-on user using the escalation template ID.
      int[] getAvailableActions(java.lang.String identifier)
      Returns the actions that can be called by the logged-on user for the specified task instance, task template, escalation instance, or escalation template using a string representation of the object ID.
      int[] getAvailableActions(TKIID tkiid)
      Returns the actions that can be called in the current task instance state by the logged-on user using the task instance ID.
      int[] getAvailableActions(TKTID tktid)
      Returns the actions that can be called in the current task template state by the logged-on user using the task template ID.
      BinaryCustomProperty getBinaryCustomProperty(ESIID esiid, java.lang.String propertyName)
      Retrieves the named binary custom property of the specified escalation instance using the escalation instance ID.
      BinaryCustomProperty getBinaryCustomProperty(java.lang.String identifier, java.lang.String propertyName)
      Retrieves the named binary custom property of the specified task or escalation instance using a string representation of the object ID.
      BinaryCustomProperty getBinaryCustomProperty(TKIID tkiid, java.lang.String propertyName)
      Retrieves the named binary custom property of the specified task instance using the task instance ID.
      java.util.List getBinaryCustomPropertyNames(ESIID esiid)
      Retrieves the names of all binary custom properties of the specified escalation instance using the escalation instance ID.
      java.util.List getBinaryCustomPropertyNames(java.lang.String identifier)
      Retrieves the names of all binary custom properties of the specified task or escalation instance using a string representation of the task or escalation instance ID.
      java.util.List getBinaryCustomPropertyNames(TKIID tkiid)
      Retrieves the names of all binary custom properties of the specified task instance using the task instance ID.
      java.util.List getCustomProperties(ESIID esiid)
      Retrieves the custom properties of the specified escalation instance using the escalation instance ID.
      java.util.List getCustomProperties(ESTID estid)
      Retrieves the custom properties of the specified escalation template using the escalation template ID.
      java.util.List getCustomProperties(java.lang.String identifier)
      Retrieves the custom properties of the specified task instance, task template, escalation instance, or escalation template using a string representation of the object ID.
      java.util.List getCustomProperties(TKIID tkiid)
      Retrieves all custom properties of the specified task instance using the task instance ID.
      java.util.List getCustomProperties(TKTID tktid)
      Retrieves the custom properties of the specified task template using the task template ID.
      java.lang.String getCustomProperty(ESIID esiid, java.lang.String propertyName)
      Retrieves the named custom property of the specified escalation instance using the escalation instance ID.
      java.lang.String getCustomProperty(ESTID estid, java.lang.String propertyName)
      Retrieves the named custom property of the specified escalation template using the escalation template ID.
      java.lang.String getCustomProperty(java.lang.String identifier, java.lang.String propertyName)
      Retrieves the named custom property of the specified task instance, task template, escalation instance, or escalation template using a string representation of the object ID.
      java.lang.String getCustomProperty(TKIID tkiid, java.lang.String propertyName)
      Retrieves the named custom property of the specified task instance using the task instance ID.
      java.lang.String getCustomProperty(TKTID tktid, java.lang.String propertyName)
      Retrieves the named custom property of the specified task template using the task template ID.
      java.util.List getCustomPropertyInfo(int objectType, java.lang.String nameFilter, java.lang.Integer threshold)
      Retrieves information about custom properties of the specified object types.
      java.util.List getCustomPropertyNames(ESIID esiid)
      Retrieves the names of all custom properties of the specified escalation instance using the escalation instance ID.
      java.util.List getCustomPropertyNames(ESTID estid)
      Retrieves the names of all custom properties of the specified escalation template using the escalation template ID.
      java.util.List getCustomPropertyNames(java.lang.String identifier)
      Retrieves the names of all custom properties of the specified task instance, task template, escalation instance, or escalation template using a string representation of the object ID.
      java.util.List getCustomPropertyNames(TKIID tkiid)
      Retrieves the names of all custom properties of the specified task instance using the task instance ID.
      java.util.List getCustomPropertyNames(TKTID tktid)
      Retrieves the names of all custom properties of the specified task template using the task template ID.
      java.lang.String getDocumentation(ESIID esiid, java.util.Locale locale)
      Retrieves the documentation of the specified escalation instance using the escalation instance ID.
      java.lang.String getDocumentation(ESTID estid, java.util.Locale locale)
      Retrieves the documentation of the specified escalation template using the escalation template ID.
      java.lang.String getDocumentation(java.lang.String identifier, java.util.Locale locale)
      Retrieves the documentation of the specified object using a string representation of the object ID.
      java.lang.String getDocumentation(TKIID tkiid, java.util.Locale locale)
      Retrieves the documentation of the specified task instance using the task instance ID.
      java.lang.String getDocumentation(TKTID tktid, java.util.Locale locale)
      Retrieves the documentation of the specified task template using the task template ID.
      Escalation getEscalation(ESIID esiid)
      Retrieves the specified escalation instance using the escalation instance ID.
      Escalation getEscalation(java.lang.String esiid)
      Retrieves the specified escalation instance using a string representation of the escalation instance ID.
      Escalation getEscalation(java.lang.String tkiid, java.lang.String escalationName)
      Retrieves the specified escalation instance using a string representation of the associated task instance ID and the escalation name.
      Escalation getEscalation(TKIID tkiid, java.lang.String escalationName)
      Retrieves the specified escalation instance using the associated task instance ID and the escalation name.
      EscalationInfo getEscalationInfo(java.lang.String tkiid)
      Retrieves information about all escalations of the specified task instance using a string representation of the task instance ID.
      EscalationInfo getEscalationInfo(TKIID tkiid)
      Retrieves information about all escalations of the specified task instance using the task instance ID.
      EscalationTemplate getEscalationTemplate(ESTID estid)
      Retrieves the specified escalation template using the escalation template ID.
      EscalationTemplate getEscalationTemplate(java.lang.String estid)
      Retrieves the specified escalation template using a string representation of the escalation template ID.
      ClientObjectWrapper getFaultMessage(java.lang.String tkiid)
      Retrieves the fault message of the specified task instance using a string representation of the task instance ID.
      ClientObjectWrapper getFaultMessage(TKIID tkiid)
      Retrieves the fault message of the specified task instance using the task instance ID.
      java.util.List getFaultNames(java.lang.String identifier)
      Retrieves the fault names defined for the specified task instance or template using a string representation of the task instance or template ID.
      java.util.List getFaultNames(TKIID tkiid)
      Retrieves the fault names defined for the specified task instance using the task instance ID.
      java.util.List getFaultNames(TKTID tktid)
      Retrieves the fault names defined for the specified task template using the task template ID.
      java.util.List getGroupDetails(java.lang.String[] groupNames, java.lang.String[] groupProperties, java.lang.String[] userProperties, java.lang.String[] subGroupProperties, java.lang.Integer threshold)
      Returns details about the specified groups.
      java.lang.String[] getGroupNames()
      Returns the names of groups the logged-on user is part of.
      HtmConfiguration getHtmConfiguration()
      Returns configuration settings of the Human Task Manager.
      InlineCustomProperty getInlineCustomProperty(java.lang.String identifier, java.lang.String propertyName)
      Retrieves the named inline custom property of the specified task template or task instance using string representations of the object IDs.
      InlineCustomProperty getInlineCustomProperty(TKIID tkiid, java.lang.String propertyName)
      Retrieves the named inline custom property of the specified task instance using the task instance ID.
      InlineCustomProperty getInlineCustomProperty(TKTID tktid, java.lang.String propertyName)
      Retrieves the named inline custom property of the specified task template using the task template ID.
      ClientObjectWrapper getInputMessage(java.lang.String tkiid)
      Retrieves the input message of the specified task instance using a string representation of the task instance ID.
      ClientObjectWrapper getInputMessage(TKIID tkiid)
      Retrieves the input message of the task instance using the task instance ID.
      java.lang.String getMessageTextOfException(java.util.Locale locale, java.lang.String messageKey, java.lang.Object[] variableValues)
      Retrieves the message text associated to the specified message key and locale.
      int getOperationMode()
      Indicates whether the Human Task Manager database is used as an archive.
      ClientObjectWrapper getOutputMessage(java.lang.String tkiid)
      Retrieves the output message of the specified task instance using a string representation of the ID.
      ClientObjectWrapper getOutputMessage(TKIID tkiid)
      Retrieves the output message of the specified task instance using the task instance ID.
      PIID getProcessID(java.lang.String tkiid)
      Retrieves the object ID of the BPEL process instance that contains the specified task instance using a string representation of the task instance ID.
      PIID getProcessID(TKIID tkiid)
      Retrieves the object ID of the BPEL process instance that contains the specified task instance using the task instance ID.
      QueryTableMetaData getQueryTableMetaData(java.lang.String queryTableName, java.util.Locale locale)
      Returns the meta data of the specified query table.
      StoredQuery getStoredQuery(int kind, java.lang.String storedQueryName)
      Retrieves the specified private or public stored query definition.
      StoredQuery getStoredQuery(java.lang.String storedQueryName)
      Retrieves the specified stored query definition.
      StoredQuery getStoredQuery(java.lang.String userID, java.lang.String storedQueryName)
      Retrieves the specified stored query definition for the specified user.
      java.lang.String[] getStoredQueryNames()
      Retrieves the names of stored queries that are persistently stored in the database.
      java.lang.String[] getStoredQueryNames(int kind)
      Retrieves the names of private or public stored queries that are persistently stored in the database.
      java.lang.String[] getStoredQueryNames(java.lang.String userID)
      Retrieves the names of stored queries that are persistently stored in the database for the specified user.
      java.util.List getSubstitutes()
      Deprecated. 
      As of version 7.0, replaced by getUserSubstitutionDetail.

      java.util.List getSubstitutes(java.lang.String userID)
      Deprecated. 
      As of version 7.0, replaced by getUserSubstitutionDetail.
      java.util.List getSubTaskIDs(java.lang.String tkiid)
      Retrieves the object IDs of all task instances that are subtasks of the specified task instance using a string representation of the task instance ID.
      java.util.List getSubTaskIDs(TKIID tkiid)
      Retrieves the object IDs of all task instances that are subtasks of the specified task instance using the task instance ID.
      Task getTask(java.lang.String tkiid)
      Retrieves the specified task instance using a string representation of the task instance ID.
      Task getTask(TKIID tkiid)
      Retrieves the specified task instance using the task instance ID.
      Task getTaskAndMarkRead(java.lang.String tkiid)
      Retrieves the specified task instance using a string representation of the task instance ID and marks the task as read.
      Task getTaskAndMarkRead(TKIID tkiid)
      Retrieves the specified task instance using the task instance ID and marks the task as read.
      java.util.List getTaskHistory(java.lang.String tkiid)
      Retrieves the history events associated to the specified task instance using a string representation of the task instance ID.
      java.util.List getTaskHistory(TKIID tkiid)
      Retrieves the history events associated to the specified task instance using the task instance ID.
      boolean getTaskRead(java.lang.String tkiid)
      States whether the specified task instance is marked read using a string representation of the task instance ID.
      boolean getTaskRead(TKIID tkiid)
      States whether the specified task instance is marked read using the task instance ID.
      TaskTemplate getTaskTemplate(java.lang.String tktid)
      Retrieves the specified task template using a string representation of the task template ID.
      TaskTemplate getTaskTemplate(TKTID tktid)
      Retrieves the specified task template using the task template ID.
      CustomClientSettings getUISettings(java.lang.String identifier)
      Retrieves client interface settings for the specified task instance or template using a string representation of the object ID.
      CustomClientSettings getUISettings(TKIID tkiid)
      Retrieves client interface settings for the specified task instance using the task instance ID.
      CustomClientSettings getUISettings(TKTID tktid)
      Retrieves client interface settings for the specified task template using the task template ID.
      java.util.List getUserDetails(java.lang.String[] userIDs, java.lang.String[] userProperties)
      Retrieves details about the specified users.
      StaffResultSet getUsersInRole(java.lang.String identifier, int role)
      Retrieves the users that are members of the specified role for the specified task instance or template using a string representation of the task instance or template ID.
      StaffResultSet getUsersInRole(TKIID tkiid, int role)
      Retrieves the users that are members of the specified role for the specified task using the task instance ID.
      StaffResultSet getUsersInRole(TKTID tktid, int role)
      Retrieves the users that are members of the specified role for the specified task template using the task template ID.
      UserSubstitutionDetail getUserSubstitutionDetail()
      Retrieves absence and substitution details about the logged-on user.
      UserSubstitutionDetail getUserSubstitutionDetail(java.lang.String userID)
      Retrieves absence and substitution details about the specified user.
      WorkItem[] getWorkItems(ESIID esiid)
      Returns the work item assignments for the logged-on user and the specified escalation instance using the escalation instance ID.
      WorkItem[] getWorkItems(java.lang.String identifier)
      Returns the work item assignments for the logged-on user and the specified task or escalation instance using a string representation of the task or escalation instance ID.
      WorkItem[] getWorkItems(TKIID tkiid)
      Returns the work item assignments for the logged-on user and the specified task instance using the task instance ID.
      boolean isSystemAdministrator()
      States whether the logged-on user is a system administrator for the Human Task Manager component.
      boolean isSystemMonitor()
      States whether the logged-on user is a task system monitor for the Human Task Manager component.
      boolean isUserInRole(java.lang.String identifier, java.lang.String userID, int role)
      States whether the specified user is a member of the specified role for the specified task instance or template using a string representation of the task instance or template ID.
      boolean isUserInRole(TKIID tkiid, java.lang.String userID, int role)
      States whether the specified user is a member of the specified role for the specified task instance using the task instance ID.
      boolean isUserInRole(TKTID tktid, java.lang.String userID, int role)
      States whether the specified user is a member of the specified role for the specified task template using the task template ID.
      QueryResultSet query(int kind, java.lang.String storedQueryName, java.lang.Integer skipTuples, java.lang.Integer threshold, java.util.List parameters)
      Performs the specified public or private stored query.
      QueryResultSet query(java.lang.String storedQueryName, java.lang.Integer skipTuples)
      Deprecated. 
      QueryResultSet query(java.lang.String storedQueryName, java.lang.Integer skipTuples, java.lang.Integer threshold)
      QueryResultSet query(java.lang.String storedQueryName, java.lang.Integer skipTuples, java.lang.Integer threshold, java.util.List parameters)
      Performs the specified stored query and specifies values for parameters in the where-clause.
      QueryResultSet query(java.lang.String storedQueryName, java.lang.Integer skipTuples, java.util.List parameters)
      Performs the specified stored query, specifies values for the parameters in the where-clause, and returns the qualifying object properties.
      QueryResultSet query(java.lang.String userID, java.lang.String storedQueryName, java.lang.Integer skipTuples, java.lang.Integer threshold, java.util.List parameters)
      Performs the specified private stored query of the specified user.
      QueryResultSet query(java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer skipTuples, java.lang.Integer threshold, java.util.TimeZone timeZone)
      Retrieves selected object properties persistently stored in the database and allows for retrieving a specified set of data only.
      QueryResultSet query(java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer threshold, java.util.TimeZone timeZone)
      Retrieves selected object properties persistently stored in the database.
      QueryResultSet queryAll(java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer skipTuples, java.lang.Integer threshold, java.util.TimeZone timeZone)
      Retrieves selected object properties of all objects persistently stored in the database and allows for retrieving a specified set of data only.
      EntityResultSet queryEntities(java.lang.String queryTableName, FilterOptions filterOptions, AuthorizationOptions authorizationOptions, java.util.List parameters)
      Queries entities using the specified query table.
      int queryEntityCount(java.lang.String queryTableName, FilterOptions filterOptions, AuthorizationOptions authorizationOptions, java.util.List parameters)
      Counts qualifying entities of a potential query for entities.
      int queryRowCount(java.lang.String queryTableName, FilterOptions filterOptions, AuthorizationOptions authorizationOptions, java.util.List parameters)
      Counts qualifying objects of a potential query table query.
      RowResultSet queryRows(java.lang.String queryTableName, FilterOptions filterOptions, AuthorizationOptions authorizationOptions, java.util.List parameters)
      Queries attributes using the specified query table.
      TaskTemplate[] queryTaskTemplates(java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer threshold, java.util.TimeZone timeZone)
      Retrieves task templates that are persistently stored in the database.
      StaffResultSet resolveStaffQuery(java.lang.String parameterizedPeopleAssignmentCriteria, java.lang.String jndiNameOfStaffPluginProvider, int substitutionPolicy, java.util.Map contextVariables)
      Tentatively resolves the specified people assignment criteria and returns the qualifying users or groups.
      void restart(java.lang.String tkiid, ClientObjectWrapper input, boolean keepResultMessages)
      Restarts the specified task instance using a string representation of the task instance ID.
      void restart(TKIID tkiid, ClientObjectWrapper input, boolean keepResultMessages)
      Restarts the specified task instance using the task instance ID.
      void resume(java.lang.String tkiid)
      Resumes the execution of the specified suspended collaboration or to-do task instance using a string representation of the task instance ID.
      void resume(TKIID tkiid)
      Resumes the execution of the specified suspended collaboration or to-do task instance using the task instance ID.
      java.util.List searchGroupDetails(java.lang.String searchCondition, java.lang.String[] groupProperties, java.lang.String[] userProperties, java.lang.String[] subGroupProperties, java.lang.Integer threshold)
      Returns details about the groups searched for.
      java.util.List searchUserDetails(java.lang.String searchCondition, java.lang.String[] userProperties, java.lang.Integer threshold)
      Returns details about the users searched for.
      void setAbsence(boolean absence)
      Deprecated. 
      As of version 7.0, replaced by setUserSubstitutionDetail.
      void setAbsence(java.lang.String userID, boolean absence)
      Deprecated. 
      As of version 7.0, replaced by setUserSubstitutionDetail.
      void setBinaryCustomProperty(ESIID esiid, BinaryCustomProperty property)
      Stores custom-specific binary values for the specified escalation instance using the escalation instance ID.
      void setBinaryCustomProperty(java.lang.String identifier, BinaryCustomProperty property)
      Stores custom-specific binary values for the specified task or escalation instance using a string representation of the task or escalation instance ID.
      void setBinaryCustomProperty(TKIID tkiid, BinaryCustomProperty property)
      Stores custom-specific binary values for the specified task instance using the task instance ID.
      void setCustomProperties(java.lang.String tkiid, java.util.List customProperties)
      Stores custom-specific values for the specified task instance using a string representation of the task instance ID.
      void setCustomProperties(TKIID tkiid, java.util.List customProperties)
      Stores custom-specific values for the specified task instance using the task instance ID.
      void setCustomProperty(ESIID esiid, java.lang.String propertyName, java.lang.String propertyValue)
      Stores custom-specific values for the specified escalation instance.
      java.util.List setCustomProperty(java.lang.String[] tkiids, java.lang.String propertyName, java.lang.String propertyValue)
      Stores custom-specific values for the specified task instances using string representations of the task instance IDs.
      void setCustomProperty(java.lang.String identifier, java.lang.String propertyName, java.lang.String propertyValue)
      Stores custom-specific values for the specified task or escalation instance using a string representation of the object ID.
      java.util.List setCustomProperty(TKIID[] tkiids, java.lang.String propertyName, java.lang.String propertyValue)
      Stores custom-specific values for the specified task instances using task instance IDs.
      void setCustomProperty(TKIID tkiid, java.lang.String propertyName, java.lang.String propertyValue)
      Stores custom-specific values for the specified task instance.
      void setFaultMessage(java.lang.String tkiid, java.lang.String faultName, ClientObjectWrapper faultMessage)
      Stores the specified fault message for the specified task instance into the database using a string representation of the task instance ID.
      void setFaultMessage(TKIID tkiid, java.lang.String faultName, ClientObjectWrapper faultMessage)
      Stores the specified fault message for the specified task instance into the database using the task instance ID.
      void setInlineCustomProperties(java.lang.String tkiid, java.util.List customProperties)
      Stores custom-specific values for the specified task instance using a string representation of the task instance ID.
      void setInlineCustomProperties(TKIID tkiid, java.util.List customProperties)
      Stores custom-specific values for the specified task instance using the task instance ID.
      java.util.List setInlineCustomProperty(java.lang.String[] tkiids, InlineCustomProperty property)
      Stores a custom-specific value for the specified task instances using string representations of the task instance IDs.
      void setInlineCustomProperty(java.lang.String tkiid, InlineCustomProperty property)
      Stores a custom-specific value for the specified task instance using a string representation of the task instance ID.
      java.util.List setInlineCustomProperty(TKIID[] tkiids, InlineCustomProperty property)
      Stores a custom-specific value for the specified task instances using task instance IDs.
      void setInlineCustomProperty(TKIID tkiid, InlineCustomProperty property)
      Stores a custom specific value for the specified task instance using the task instance ID.
      void setInputMessage(java.lang.String tkiid, ClientObjectWrapper inputMessage)
      Stores the input message of the specified task instance into the database using a string representation of the task instance ID.
      void setInputMessage(TKIID tkiid, ClientObjectWrapper inputMessage)
      Stores the input message of the specified task instance into the database using the task instance ID.
      void setOutputMessage(java.lang.String tkiid, ClientObjectWrapper outputMessage)
      Stores the output message of the specified task instance into the database using a string representation of the task instance ID.
      void setOutputMessage(TKIID tkiid, ClientObjectWrapper outputMessage)
      Stores the output message of the specified task instance into the database using the task instance ID.
      void setSubstitutes(java.util.List substitutes)
      Deprecated. 
      As of version 7.0, replaced by setUserSubstitutionDetail.
      void setSubstitutes(java.lang.String userID, java.util.List substitutes)
      Deprecated. 
      As of version 7.0, replaced by setUserSubstitutionDetail.
      void setTaskRead(java.lang.String tkiid, boolean newValue)
      Specifies whether the specified task instance is to be marked as read using a string representation of the task instance ID.
      void setTaskRead(TKIID tkiid, boolean newValue)
      Specifies whether the specified task instance is to be marked as read using the task instance ID.
      void setUserSubstitutionDetail(java.lang.String userID, UserSubstitutionDetail substitutionDetail)
      Sets absence and substitution details for the specified user.
      void setUserSubstitutionDetail(UserSubstitutionDetail substitutionDetail)
      Sets absence and substitution details for the logged-on user.
      void startTask(java.lang.String tkiid, ClientObjectWrapper input, ReplyHandlerWrapper replyHandler)
      Asynchronously executes a previously created task using a string representation of the task instance ID.
      void startTask(TKIID tkiid, ClientObjectWrapper input, ReplyHandlerWrapper replyHandler)
      Asynchronously executes a previously created task using the task instance ID.
      void startTaskAsSubTask(java.lang.String tkiid, java.lang.String parentTaskID, ClientObjectWrapper input)
      Executes a previously created task as a subtask of the specified parent task instance using a string representation of the task instance ID.
      void startTaskAsSubTask(TKIID tkiid, TKIID parentTaskID, ClientObjectWrapper input)
      Executes a previously created task as a subtask of the specified parent task instance using the task instance ID.
      void startTaskTemplate(java.lang.String tktid)
      This method starts a task template that has been created at Runtime using a string representation of the task template ID.
      void startTaskTemplate(TKTID tktid)
      This method starts a task template that has been created at Runtime using the task template ID.
      void stopTaskTemplate(java.lang.String tktid)
      This method stops a task template that has been created at Runtime using a string representation of the task template ID.
      void stopTaskTemplate(TKTID tktid)
      This method stops a task template that has been created at Runtime using the task template ID.
      void suspend(java.lang.String tkiid)
      Suspends the specified collaboration or to-do task instance using a string representation of the task instance ID.
      void suspend(java.lang.String tkiid, java.util.Calendar deadline)
      Suspends the specified collaboration or to-do task instance until the specified point in time is reached using a string representation of the task instance ID.
      void suspend(java.lang.String tkiid, int duration)
      Suspends the specified collaboration or to-do task instance for the specified number of seconds using a string representation of the task instance ID.
      void suspend(java.lang.String tkiid, java.lang.String duration)
      Suspends the specified collaboration or to-do task instance for the specified duration using a string representation of the task instance ID.
      void suspend(TKIID tkiid)
      Suspends the specified collaboration or to-do task instance using the task instance ID.
      void suspend(TKIID tkiid, java.util.Calendar deadline)
      Suspends the specified collaboration or to-do task instance until the specified point in time is reached using the task instance ID.
      void suspend(TKIID tkiid, int duration)
      Suspends the specified collaboration or to-do task instance for the specified number of seconds using the task instance ID.
      void suspend(TKIID tkiid, java.lang.String duration)
      Suspends the specified collaboration or to-do task instance for the specified duration using the task instance ID.
      void suspendAndCancelClaim(java.lang.String tkiid, java.util.Calendar deadline, boolean keepTaskData)
      Suspends the specified collaboration or to-do task instance until the specified point in time is reached, and cancels the claim of the task instance when execution is resumed using a string representation of the task instance ID.
      void suspendAndCancelClaim(java.lang.String tkiid, int duration, boolean keepTaskData)
      Suspends the specified collaboration or to-do task instance for the specified number of seconds and cancels the claim of the task instance when execution is resumed using a string representation of the task instance ID.
      void suspendAndCancelClaim(java.lang.String tkiid, java.lang.String duration, boolean keepTaskData)
      Suspends the specified collaboration or to-do task instance for the specified duration and cancels the claim of the task instance when execution is resumed using a string representation of the task instance ID.
      void suspendAndCancelClaim(TKIID tkiid, java.util.Calendar deadline, boolean keepTaskData)
      Suspends the specified collaboration or to-do task instance until the specified point in time is reached, and cancels the claim of the task instance when execution is resumed using the task instance ID.
      void suspendAndCancelClaim(TKIID tkiid, int duration, boolean keepTaskData)
      Suspends the specified collaboration or to-do task instance for the specified number of seconds and cancels the claim of the task instance when execution is resumed using the task instance ID.
      void suspendAndCancelClaim(TKIID tkiid, java.lang.String duration, boolean keepTaskData)
      Suspends the specified collaboration or to-do task instance for the specified duration and cancels the claim of the task instance when execution is resumed using the task instance ID.
      void terminate(java.lang.String tkiid)
      Terminates the specified task instance using a string representation of the task instance ID.
      void terminate(TKIID tkiid)
      Terminates the specified task instance using the task instance ID.
      java.util.List transferToWorkBasket(java.lang.String[] tkiids, java.lang.String workBasketName)
      Transfers the specified task instances to the specified work basket using string representations of the task instance IDs.
      java.util.List transferToWorkBasket(TKIID[] tkiids, java.lang.String workBasketName)
      Transfers the specified task instances to the specified work basket using task instance IDs.
      java.util.List transferWorkItem(ESIID[] esiids, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner)
      Transfers the specified work items for the specified escalation instances using escalation instance IDs.
      void transferWorkItem(ESIID esiid, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner)
      Transfers the specified work item for the specified escalation instance using the escalation instance ID.
      java.util.List transferWorkItem(java.lang.String[] identifiers, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner)
      Transfers the specified work items for the specified escalation or task instances using string representations of escalation or task instance IDs.
      void transferWorkItem(java.lang.String identifier, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner)
      Transfers the specified work item using a string representation of the task or escalation instance ID.
      java.util.List transferWorkItem(TKIID[] tkiids, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner)
      Transfers the specified work items for the specified task instances using task instance IDs.
      void transferWorkItem(TKIID tkiid, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner)
      Transfers the specified work item for the specified task instance using the task instance ID.
      void triggerEscalation(ESIID esiid)
      Manually triggers the specified escalation instance using the escalation instance ID.
      void triggerEscalation(java.lang.String esiid)
      Manually triggers the specified escalation instance using a string representation of the escalation instance ID.
      void update(Escalation escalation)
      Updates a persistently stored escalation instance.
      void update(java.lang.String tkiid, TaskModel taskModel, java.lang.String applicationName, java.lang.String parentContext, ClientObjectWrapper input)
      Updates a task instance that has been created at Runtime using a string representation of the task instance ID.
      void update(Task task)
      Updates a persistently stored task instance.
      void update(TKIID tkiid, TaskModel taskModel, java.lang.String applicationName, java.lang.String parentContext, ClientObjectWrapper input)
      Updates a task instance that has been created at Runtime using the task instance ID.
IBM Business Process ManagerTM
Release 8