|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface HumanTaskManagerDelegate
HumanTaskManagerDelegate wraps the functions of the Human Task Manager API and hides the details of setting up the communication.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
Method Summary | |
---|---|
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. |
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 name,
java.lang.String namespace,
ClientObjectWrapper input)
Creates and synchronously executes an invocation task instance. |
TKIID |
createAndStartTask(java.lang.String name,
java.lang.String namespace,
ClientObjectWrapper input,
ReplyHandlerWrapper replyHandler)
Creates and starts a task instance. |
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 |
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. |
ClientObjectWrapper |
createFaultMessage(java.lang.String tkiid,
java.lang.String faultName)
Creates a fault message for a fault that is defined by the specified task instance using a string representation of the task instance 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 |
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. Use createInputMessage ,
createOutputMessage ,
createFaultMessage . |
ClientObjectWrapper |
createMessage(TKIID tkiid,
java.lang.String messageTypeName)
Deprecated. Use createInputMessage ,
createOutputMessage ,
createFaultMessage . |
ClientObjectWrapper |
createOutputMessage(java.lang.String tkiid)
Creates an output message for the specified task instance using a string representation of the task instance ID. |
ClientObjectWrapper |
createOutputMessage(TKIID tkiid)
Creates an output message for the specified task instance using the task instance 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 name,
java.lang.String namespace)
Creates a task instance. |
TKIID |
createTask(java.lang.String name,
java.lang.String namespace,
ClientObjectWrapper input)
Creates a task instance 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. |
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. |
void |
executeQuery(ExecutableQuery query)
Retrieves selected object properties persistently stored in the database using a predefined query object. |
boolean |
getAbsence()
Returns the absence setting of the logged-on user. |
boolean |
getAbsence(java.lang.String userID)
Returns the absence setting of the specified user. |
com.ibm.bpe.api.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. |
com.ibm.bpe.api.AIID |
getActivityID(TKIID tkiid)
Retrieves the object ID of the activity instance associated to the specified task instance using the task instance 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 all custom properties of the specified escalation instance using the escalation instance ID. |
java.util.List |
getCustomProperties(ESTID estid)
Retrieves all custom properties of the specified escalation template using the escalation template ID. |
java.util.List |
getCustomProperties(java.lang.String identifier)
Retrieves 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 |
getCustomProperties(TKIID tkiid)
Retrieves all custom properties of the specified task instance using the task instance ID. |
java.util.List |
getCustomProperties(TKTID tktid)
Retrieves all 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. |
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 tkiid)
Retrieves the fault names defined for the specified task instance using a string representation of the task instance 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 |
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. |
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. |
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. |
com.ibm.bpe.api.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. |
com.ibm.bpe.api.PIID |
getProcessID(TKIID tkiid)
Retrieves the object ID of the BPEL process instance that contains the specified task instance using the task instance ID. |
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()
Retrieves the substitutes of the logged-on user. |
java.util.List |
getSubstitutes(java.lang.String userID)
Retrieves the substitutes of the specified user. |
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. |
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)
Returns 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. |
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. Use query(Sting storedQueryName, Integer skipTuples, List parameters) , |
QueryResultSet |
query(java.lang.String storedQueryName,
java.lang.Integer skipTuples,
java.lang.Integer threshold)
Deprecated. Use query(Sting storedQueryName, Integer skipTuples, Integer threshold, List parameters) , |
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. |
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 and that are part of started applications. |
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)
Sets the absence information of the logged-on user to the specified value. |
void |
setAbsence(java.lang.String userID,
boolean absence)
Sets the absence information of the specified user to the specified value. |
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 |
setCustomProperty(ESIID esiid,
java.lang.String propertyName,
java.lang.String propertyValue)
Stores custom-specific values for the specified escalation instance. |
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. |
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 |
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)
Sets the substitutes of the logged-on user. |
void |
setSubstitutes(java.lang.String userID,
java.util.List substitutes)
Sets the substitutes of the specified 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 spontaneously using a string representation of the task template ID. |
void |
startTaskTemplate(TKTID tktid)
This method starts a task template that has been created spontaneously using the task template ID. |
void |
stopTaskTemplate(java.lang.String tktid)
This method stops a task template that has been created spontaneously using a string representation of the task template ID. |
void |
stopTaskTemplate(TKTID tktid)
This method stops a task template that has been created spontaneously 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 |
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 |
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 spontaneously 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 spontaneously using the task instance ID. |
Field Detail |
---|
static final java.lang.String COPYRIGHT
Method Detail |
---|
void executeQuery(ExecutableQuery query) throws CommunicationException, ParameterNullException, WorkItemManagerException, UnexpectedFailureException
query
- The query specification
CommunicationException
ParameterNullException
WorkItemManagerException
UnexpectedFailureException
java.util.List bulkTransferWorkItem(java.lang.String[] identifiers, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner) throws IdWrongFormatException, IdWrongTypeException, InvalidAssignmentReasonException, ParameterNullException, UserDoesNotExistException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
This method is particularly suitable in cases where processing large numbers of tasks or escalations is required, and where the application is not concerned that the transfer happens as part of an enclosing global transaction.
When work items of a task instance are transferred, then the caller must be an owner, starter, originator, or administrator of the task instances. The task can be escalated. suspended, or waiting for subtasks.
When work items of an escalation instance are transferred, then the caller must be an administrator of the associated task instances. Escalation-receiver work items can be transferred when the task is escalated, that is, the escalation is in the escalated state.
The following specific rules apply for the transfer of work items:
identifiers
- An array of escalation instance or task instance IDs that are used to identify
the work items to be transferred.assignmentReason
- The reason why the work item is assigned - refer to
WorkItem.getAssignmentReason
.fromOwner
- The user ID or the name of the group the work item currently belongs to.toOwner
- The user ID or the name of the group the work item is to be transferred to.
Work items can be transferred from a user to a user or from a group of users to a group of users.
If a user work item is transferred, it is checked whether the user transferred to
exists but the check may be executed case insensitively.
The check can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments'
custom property of the Human Task Manager configuration to 'true'.
TaskResult
to view the TaskResult properties.
Returns an empty list when all transfers executed successfully.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
InvalidAssignmentReasonException
ParameterNullException
UserDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
java.util.List bulkTransferWorkItem(ESIID[] esiids, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner) throws IdWrongFormatException, InvalidAssignmentReasonException, ParameterNullException, UserDoesNotExistException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
This method is particularly suitable in cases where processing large numbers of escalations is required, and where the application is not concerned that the transfer happens as part of an enclosing global transaction.
The caller must be an administrator of the associated task instances. Escalation-receiver work items can be transferred when the task is escalated, that is, the escalation is in the escalated state. An e-mail is not sent to the user or group that receives the transferred work item.
esiids
- Array of escalation instance IDs that are used to identify
the work items to be transferred.assignmentReason
- The reason why the work item is assigned - refer to
WorkItem.getAssignmentReason
.fromOwner
- The user ID or the name of the group the work item currently belongs to.toOwner
- The user ID or the name of the group the work item is to be transferred to.
Work items can be transferred from a user to a user or from a group of users to a group of users.
If a user work item is transferred, it is checked whether the user transferred to
exists but the check may be executed case insensitively.
The check can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments'
custom property of the Human Task Manager configuration to 'true'.
EscalationResult
to view the EscalationResult properties.
Returns an empty list when all transfers executed successfully.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
InvalidAssignmentReasonException
ParameterNullException
UserDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
java.util.List bulkTransferWorkItem(TKIID[] tkiids, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner) throws IdWrongFormatException, InvalidAssignmentReasonException, ParameterNullException, UserDoesNotExistException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
This method is particularly suitable in cases where processing large numbers of tasks is required, and where the application is not concerned that the transfer happens as part of an enclosing global transaction.
The caller must be an owner, starter, originator, or administrator of the task instances. The task can be escalated. suspended, or waiting for subtasks.
The following specific rules apply for the transfer of work items:
tkiids
- An array of task instance IDs that are used to identify
the work items to be transferred.assignmentReason
- The reason why the work item is assigned - refer to
WorkItem.getAssignmentReason
.fromOwner
- The user ID or the name of the group the work item currently belongs to.toOwner
- The user ID or the name of the group the work item is to be transferred to.
Work items can be transferred from a user to a user or from a group of users to a group of users.
If a user work item is transferred, it is checked whether the user transferred to
exists but the check may be executed case insensitively.
The check can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments'
custom property of the Human Task Manager configuration to 'true'.
TaskResult
to view the TaskResult properties.
Returns an empty list when all transfers executed successfully.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
InvalidAssignmentReasonException
ParameterNullException
UserDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
ClientObjectWrapper callTask(java.lang.String tkiid, ClientObjectWrapper input) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, FaultReplyException, IdWrongFormatException, IdWrongTypeException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, SCAServiceAccessFailureException, SCAServiceResultErrorException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
An invocation task instance is also known as originating task instance.
This method returns only when the execution of the task finishes with the result of execution. If a fault occurs, an exception is thrown. The service that is called must be a two-way operation. Otherwise, SCAServiceAccessFailureException is thrown.
The task instance must be a stand-alone task in the inactive state. The caller must be a potential starter, the originator, or an administrator of the task instance.
tkiid
- A string representation of the task instance ID that is used
to identify the task instance.input
- The input message.
The object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
FaultReplyException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
SCAServiceAccessFailureException
SCAServiceResultErrorException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
ClientObjectWrapper callTask(TKIID tkiid, ClientObjectWrapper input) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, FaultReplyException, IdWrongFormatException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, SCAServiceAccessFailureException, SCAServiceResultErrorException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
An invocation task instance is also known as originating task instance.
This method returns only when the execution of the task finishes with the result of execution. If a fault occurs, an exception is thrown. The service that is called must be a two-way operation. Otherwise, SCAServiceAccessFailureException is thrown.
The task instance must be a stand-alone task in the inactive state. The caller must be a potential starter, the originator, or an administrator of the task instance.
tkiid
- The task instance ID that is used to identify the task instance.input
- The input message.
The object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
FaultReplyException
IdWrongFormatException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
SCAServiceAccessFailureException
SCAServiceResultErrorException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void cancelClaim(java.lang.String tkiid) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must have been claimed. It can be escalated.
The task instance is returned to the ready state. Any previously stored output or fault message is deleted.
The caller must be the owner or an administrator of the task instance.
tkiid
- A string representation of the task instance ID that is used
to identify the task instance.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void cancelClaim(TKIID tkiid) throws ApplicationVetoException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must have been claimed. It can be escalated.
The task instance is returned to the ready state. Any previously stored output or fault message is deleted.
The caller must be the owner or an administrator of the task instance.
tkiid
- The task instance ID that is used to identify the task instance.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void cancelClaim(java.lang.String tkiid, boolean keepTaskData) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must have been claimed. It can be escalated.
The task instance is returned to the ready state. If specified, any previously stored output or fault message is kept.
The caller must be the owner or an administrator of the task instance.
tkiid
- A string representation of the task instance ID that is used
to identify the task instance.keepTaskData
- Specifies whether data saved for the claimed task instance is to be kept.
True states that any output or fault message set is to be kept.
False states that any output or fault message set is to be deleted.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void cancelClaim(TKIID tkiid, boolean keepTaskData) throws ApplicationVetoException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must have been claimed. It can be escalated.
The task instance is returned to the ready state. If specified, any previously stored output or fault message is kept.
The caller must be the owner or an administrator of the task instance.
tkiid
- The task instance ID that is used to identify the task instance.keepTaskData
- Specifies whether data saved for the claimed task instance is to be kept.
True states that any output or fault message set is to be kept.
False states that any output or fault message set is to be deleted.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
java.util.List cancelClaim(java.lang.String[] identifiers) throws IdWrongFormatException, IdWrongTypeException, UnexpectedFailureException, CommunicationException
The task instances must have been claimed. They can be escalated.
The task instances are returned to the ready state. Any previously stored output or fault message is deleted.
The caller must be the owner or an administrator of the task instances.
identifiers
- An array of task instance IDs that are used to identify the task instances
to be released.
TaskResult
.
If a single cancelClaim operation fails because any of the following exceptions has been thrown, then the result object contains the respective exception. Otherwise, the TaskException property is null.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
UnexpectedFailureException
java.util.List cancelClaim(TKIID[] tkiids) throws IdWrongFormatException, UnexpectedFailureException, CommunicationException
The task instances must have been claimed. They can be escalated.
The task instances are returned to the ready state. Any previously stored output or fault message is deleted.
The caller must be the owner or an administrator of the task instances.
tkiids
- An array of task instance IDs that are used to identify the task instances
to be released.
TaskResult
.
If a single cancelClaim operation fails because any of the following exceptions has been thrown, then the result object contains the respective exception. Otherwise, the TaskException property is null.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
UnexpectedFailureException
ClientObjectWrapper claim(java.lang.String tkiid) throws ApplicationVetoException, CannotCreateWorkItemException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
Collaboration and to-do task instances are also known as human and participating task instances.
The caller must be a potential owner or an administrator of the task instance.
The state of the task instance is changed to claimed.
Refer to complete
for information on how
to complete a task instance.
tkiid
- A string representation of the task instance ID that is used
to identify the task instance to be claimed.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
ClientObjectWrapper claim(TKIID tkiid) throws ApplicationVetoException, CannotCreateWorkItemException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
Collaboration and to-do task instances are also known as human and participating task instances.
The caller must be a potential owner or an administrator of the task instance.
The state of the task instance is changed to claimed.
Refer to complete
for information
on how to complete a task instance.
tkiid
- The object ID of the task instance to be claimed.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Task claim(java.lang.String whereClause, java.lang.String orderByClause, java.util.TimeZone timeZone) throws CannotCreateWorkItemException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
Collaboration and to-do task instances are also known as human and participating task instances.
The task instance that is claimed is identified by the specified where- and order-by-clauses. The first task instance is claimed that qualifies under these conditions, that is not suspended, and for which the caller is a potential owner or administrator.
Refer to complete
for information on how
to complete a task instance.
whereClause
- The search condition to be applied to the query domain.
The search condition is used to filter the set of ready and not suspended task
instances that can be claimed by the logged-on user.
Its syntax is an SQL where-clause. The following rules apply:
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 and not suspended tasks.
Its syntax is an SQL order-by-clause. Each comma separated part of the order-by-clause
must specify a property from the
published views - see the InfoCenter for details.
If you identify more that one property, the query result set is ordered by the values of the first property you identify, then by the values of the second property, and so on.
If sort criteria are not to be applied, null must be specified.
Note that sort criteria are applied on the server, that is, the locale of the server is used for sorting.
timeZone
- Specifies the time zone of the timestamp constants in the whereClause
respectively the time zone for the timestamp values returned.
If a timezone is not specified, UTC is assumed.
Task
to view the task instance properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
CannotCreateWorkItemException
WorkItemManagerException
UnexpectedFailureException
java.util.List claim(java.lang.String[] identifiers) throws CannotCreateWorkItemException, IdWrongFormatException, IdWrongTypeException, UnexpectedFailureException, CommunicationException
Collaboration and to-do task instances are also known as human and participating task instances.
The caller must be a potential owner or an administrator of the task instances.
The states of the task instances are changed to claimed.
Refer to complete
for information on how
to complete a task instance.
identifiers
- An array of task instance IDs that are used to identify the task instances
to be claimed.
ClaimResult
.
If a single claim operation fails because any of the following exceptions has been thrown, then the result object contains the respective exception. Otherwise, the TaskException property is null.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
CannotCreateWorkItemException
IdWrongFormatException
IdWrongTypeException
UnexpectedFailureException
java.util.List claim(TKIID[] tkiids) throws CannotCreateWorkItemException, IdWrongFormatException, UnexpectedFailureException, CommunicationException
Collaboration and to-do task instances are also known as human and participating task instances.
The caller must be a potential owner or an administrator of the task instances.
The states of the task instances are changed to claimed.
Refer to complete
for information on how
to complete a task instance.
tkiids
- An array of task instance IDs that are used to identify the task instances
to be claimed.
ClaimResult
.
If a single claim operation fails because any of the following exceptions has been thrown, then the result object contains the respective exception. Otherwise, the TaskException property is null.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
CannotCreateWorkItemException
IdWrongFormatException
UnexpectedFailureException
void complete(java.lang.String tkiid) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be in the claimed state. It can be escalated. The caller must be the owner or an administrator of the task instance.
Completion of a task instance means that user processing has finished. If user processing completed successfully, the task instance is put into the finished state.
If user processing did not complete successfully, that is, if a fault message is set, the task instance is put into the failed state.
tkiid
- A string representation of the task instance ID that is used
to identify the task instance to be completed.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void complete(TKIID tkiid) throws ApplicationVetoException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be in the claimed state. It can be escalated. The caller must be the owner or an administrator of the task instance.
Completion of a task instance means that user processing has finished. If user processing completed successfully, the task instance is put into the finished state.
If user processing did not complete successfully, that is, if a fault message is set, the task instance is put into the failed state.
tkiid
- The object ID to identify the task instance to be completed.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void complete(java.lang.String tkiid, ClientObjectWrapper output) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be in the claimed state. It can be escalated. The caller must be the owner or an administrator of the task instance.
tkiid
- A string representation of the task instance ID that is used
to identify the task instance to be completed.output
- The output message that denotes the successful result of processing.
Note that an object wrapped by the ClientObjectWrapper must be serializable.
Any previously set output or fault message is ignored.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void complete(TKIID tkiid, ClientObjectWrapper output) throws ApplicationVetoException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be in the claimed state. It can be escalated. The caller must be the owner or an administrator of the task instance.
tkiid
- The object ID to identify the task instance to be completed.output
- The output message that denotes the successful result of processing.
Note that an object wrapped by the ClientObjectWrapper must be serializable.
Any previously set output or fault message is ignored.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void complete(java.lang.String tkiid, java.lang.String faultName, ClientObjectWrapper faultMessage) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, InvalidQNameException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be in the claimed state. It can be escalated. The caller must be the owner or an administrator of the task instance.
Completion of a task instance means that user processing finished. A fault message is passed to state the unsuccessful execution of user processing. The task instance is put into the failed state.
tkiid
- A string representation of the task instance ID that is used
to identify the task instance to be completed.faultName
- A fault name to state unsuccessful processing. The fault name must point to
a fault that is defined for the task.
Refer to getFaultNames
.faultMessage
- The fault message. Not that the object
wrapped by the ClientObjectWrapper must be serializable.
Any previously set output or fault message is ignored.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
InvalidQNameException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void complete(TKIID tkiid, java.lang.String faultName, ClientObjectWrapper faultMessage) throws ApplicationVetoException, IdWrongFormatException, InvalidQNameException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be in the claimed state. It can be escalated. The caller must be the owner or an administrator of the task instance.
Completion of a task instance means that user processing finished. A fault message is passed to state the unsuccessful execution of user processing. The task instance is put into the failed state.
tkiid
- The object ID to identify the task instance to be completed.faultName
- A fault name to state unsuccessful processing. The fault name must point to
a fault that is defined for the task.
Refer to getFaultNames
.faultMessage
- The fault message. Note that the object
wrapped by the ClientObjectWrapper must be serializable.
Any previously set output or fault message is ignored.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
InvalidQNameException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
java.util.List complete(java.lang.String[] tkiids) throws IdWrongFormatException, IdWrongTypeException, UnexpectedFailureException, CommunicationException
The task instances must be in the claimed state. They can be escalated. The caller must be the owner or an administrator of the task instances.
Completion of a task instance means that user processing has finished. If user processing completed successfully, the task instance is put into the finished state.
If user processing did not complete successfully, that is, if a fault message has been set, the task instance is put into the failed state.
tkiids
- An array of task instance IDs that identify the task instances to be completed
TaskResult
.
If a single complete operation fails because any of the following exceptions has been thrown, then the result object contains the respective exception. Otherwise, the TaskException property is null.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
UnexpectedFailureException
java.util.List complete(TKIID[] tkiids) throws IdWrongFormatException, UnexpectedFailureException, CommunicationException
The task instances must be in the claimed state. They can be escalated. The caller must be the owner or an administrator of the task instances.
Completion of a task instance means that user processing has finished. If user processing completed successfully, the task instance is put into the finished state.
If user processing did not complete successfully, that is, if a fault message has been set, the task instance is put into the failed state.
tkiids
- An array of task instance IDs that identify the task instances to be completed
TaskResult
.
If a single complete operation fails because any of the following exceptions has been thrown, then the result object contains the respective exception. Otherwise, the TaskException property is null.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
UnexpectedFailureException
void completeWithFollowOnTask(java.lang.String tkiid, java.lang.String followOnID, ClientObjectWrapper input) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, FaultMessageDefinitionDoesNotMatchException, FollowOnTasksNotSupportedException, IdWrongFormatException, IdWrongTypeException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, OutputMessageDefinitionDoesNotMatchException, SCAServiceAccessFailureException, SCAServiceResultErrorException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance that is completed must be in the claimed state. It can be escalated. As a result of this call, it is set into the forwarded state. If a reply handler is specified, it is called when the last follow-on task in a possible chain is finished.
The task instance that is started as follow-on task must be in the inactive state. It can be a collaboration or stand-alone invocation task. Escalation or deletion timer settings of the completed task become active.
Collaboration and invocation task instances are also known as human and originating task instances.
The output and fault message definitions of the completed and the follow-on task must be of the same type. The types of the input messages may differ. Any output or fault message stored persistently is automatically passed to the follow-on task. The input message is passed if it is of the same type and if not specified otherwise - see the input parameter below.
The caller must be the owner or an administrator of the task instance that is to be completed and must be allowed to at least read the follow-on task.
tkiid
- A string representation of the task instance ID that is used
to identify the task instance to be completed.followOnID
- A string representation of the task instance ID that is used
to identify the task instance that is to follow.input
- An optional input message for the follow-on task. If not specified,
the input message of the completed task is passed to the follow-on task provided
that they are of the same type.
Note that an object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
FaultMessageDefinitionDoesNotMatchException
FollowOnTasksNotSupportedException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
OutputMessageDefinitionDoesNotMatchException
SCAServiceAccessFailureException
SCAServiceResultErrorException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void completeWithFollowOnTask(TKIID tkiid, TKIID followOnID, ClientObjectWrapper input) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, FaultMessageDefinitionDoesNotMatchException, FollowOnTasksNotSupportedException, IdWrongFormatException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, OutputMessageDefinitionDoesNotMatchException, SCAServiceAccessFailureException, SCAServiceResultErrorException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance that is completed must be in the claimed state. It can be escalated. As a result of this call, it is set into the forwarded state. If a reply handler is specified, it is called when the last follow-on task in a possible chain is finished.
The task instance that is started as follow-on task must be in the inactive state. It can be a collaboration or stand-alone invocation task. Escalation or deletion timer settings of the completed task become active.
Collaboration and invocation task instances are also known as human and originating task instances.
The output and fault message definitions of the completed and the follow-on task must be of the same type. The types of the input messages may differ. Any output or fault message stored persistently is automatically passed to the follow-on task. The input message is passed if it is of the same type and if not specified otherwise - see the input parameter below.
The caller must be the owner or an administrator of the task instance that is to be completed and must be allowed to at least read the follow-on task.
tkiid
- The object ID to identify the task instance to be completed.followOnID
- The object ID
to identify the task instance that is to follow.input
- An optional input message for the follow-on task. If not specified,
the input message of the completed task is passed to the follow-on task provided
that they are of the same type.
Note that an object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
FaultMessageDefinitionDoesNotMatchException
FollowOnTasksNotSupportedException
IdWrongFormatException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
OutputMessageDefinitionDoesNotMatchException
SCAServiceAccessFailureException
SCAServiceResultErrorException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void completeWithNewFollowOnTask(java.lang.String tkiid, java.lang.String name, java.lang.String namespace, ClientObjectWrapper input) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, FaultMessageDefinitionDoesNotMatchException, FollowOnTasksNotSupportedException, IdWrongFormatException, IdWrongTypeException, InvalidApplicationStateException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, OutputMessageDefinitionDoesNotMatchException, ParameterNullException, SCAServiceAccessFailureException, SCAServiceResultErrorException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance that is completed must be in the claimed state. It can be escalated. As a result of this call, it is set into the forwarded state. If a reply handler is specified, it is called when the last follow-on task in a possible chain is finished.
The task instance that is created and started as follow-on task must be a collaboration or stand-alone invocation task. Escalation or deletion timer settings of the completed task become active.
Collaboration and invocation task instances are also known as human and originating task instances.
The output and fault message definitions of the completed and the follow-on task must be of the same type. The types of the input messages may differ. Any output or fault message stored persistently is automatically passed to the follow-on task. The input message is passed if it is of the same type and if not specified otherwise - see the input parameter below.
The caller must be the owner or an administrator of the completed task instance. The caller must be a potential instance creator or an administrator of the task template.
tkiid
- A string representation of the task instance ID that is used
to identify the task instance to be completed.name
- The name of the task template from which an instance is to be created
as follow-on task. The currently valid template is then instantiated.namespace
- The namespace of the task template.input
- An optional input message for the follow-on task. If not specified,
the input message of the completed task is passed to the follow-on task provided
that they are of the same type.
Note that an object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
FaultMessageDefinitionDoesNotMatchException
FollowOnTasksNotSupportedException
IdWrongFormatException
IdWrongTypeException
InvalidApplicationStateException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
OutputMessageDefinitionDoesNotMatchException
ParameterNullException
SCAServiceAccessFailureException
SCAServiceResultErrorException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void completeWithNewFollowOnTask(TKIID tkiid, java.lang.String name, java.lang.String namespace, ClientObjectWrapper input) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, FaultMessageDefinitionDoesNotMatchException, FollowOnTasksNotSupportedException, IdWrongFormatException, InvalidApplicationStateException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, OutputMessageDefinitionDoesNotMatchException, ParameterNullException, SCAServiceAccessFailureException, SCAServiceResultErrorException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance that is completed must be in the claimed state. It can be escalated. As a result of this call, it is set into the forwarded state. If a reply handler is specified, it is called when the last follow-on task in a possible chain is finished.
The task instance that is created and started as follow-on task must be a collaboration or stand-alone invocation task. Escalation or deletion timer settings of the completed task become active.
Collaboration and invocation task instances are also known as human and originating task instances.
The output and fault message definitions of the completed and the follow-on task must be of the same type. The types of the input messages may differ. Any output or fault message stored persistently is automatically passed to the follow-on task. The input message is passed if it is of the same type and if not specified otherwise - see the input parameter below.
The caller must be the owner or an administrator of the completed task instance. The caller must be a potential instance creator or an administrator of the task template.
tkiid
- The object ID to identify the task instance to be completed.name
- The name of the task template from which an instance is to be created
as follow-on task. The currently valid template is then instantiated.namespace
- The namespace of the task template.input
- An optional input message for the follow-on task. If not specified,
the input message of the completed task is passed to the follow-on task provided
that they are of the same type.
Note that an object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
FaultMessageDefinitionDoesNotMatchException
FollowOnTasksNotSupportedException
IdWrongFormatException
InvalidApplicationStateException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
OutputMessageDefinitionDoesNotMatchException
ParameterNullException
SCAServiceAccessFailureException
SCAServiceResultErrorException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void completeWithNewFollowOnTask(java.lang.String tkiid, TaskModel taskModel, java.lang.String applicationName, ClientObjectWrapper input) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, FaultMessageDefinitionDoesNotMatchException, FollowOnTasksNotSupportedException, IdWrongFormatException, IdWrongTypeException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, OutputMessageDefinitionDoesNotMatchException, ParameterNullException, com.ibm.task.plugins.TaskDeploymentException, com.ibm.task.plugins.TELValidationException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance that is completed must be in the claimed state. It can be escalated. As a result of this call, it is set into the forwarded state. If a reply handler is specified, it is called when the last follow-on task in a possible chain is finished.
The task instance that is created and started as follow-on task must be a collaboration or stand-alone invocation task. Escalation or deletion timer settings of the completed task become active.
Collaboration and invocation task instances are also known as human and originating task instances.
The output and fault message definitions of the completed and the follow-on task must be of the same type. The types of the input messages may differ. Any output or fault message stored persistently is automatically passed to the follow-on task. The input message is passed if it is of the same type and if not specified otherwise - see the input parameter below.
The caller must be the owner or an administrator of the completed task instance. The caller must have potential-instance-creator rights on the associated application component which is inherited from the completed task instance.
tkiid
- A string representation of the task instance ID that is used
to identify the task instance to be completed.taskModel
- The model that describes the task template from which a follow-on task is
to be created spontaneously.applicationName
- The name of the enterprise application that contains the message
or business calendar definitions used in the TaskModel.
If the message definitions are simple types only or if you do not use a business
calendar, null may be specified.input
- An optional input message for the follow-on task. If not specified,
the input message of the completed task is passed to the follow-on task provided
that they are of the same type.
Note that an object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
FaultMessageDefinitionDoesNotMatchException
FollowOnTasksNotSupportedException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
OutputMessageDefinitionDoesNotMatchException
ParameterNullException
com.ibm.task.plugins.TaskDeploymentException
com.ibm.task.plugins.TELValidationException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void completeWithNewFollowOnTask(TKIID tkiid, TaskModel taskModel, java.lang.String applicationName, ClientObjectWrapper input) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, FaultMessageDefinitionDoesNotMatchException, FollowOnTasksNotSupportedException, IdWrongFormatException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, OutputMessageDefinitionDoesNotMatchException, ParameterNullException, com.ibm.task.plugins.TaskDeploymentException, com.ibm.task.plugins.TELValidationException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance that is completed must be in the claimed state. It can be escalated. As a result of this call, it is set into the forwarded state. If a reply handler is specified, it is called when the last follow-on task in a possible chain is finished.
The task instance that is created and started as follow-on task must be a collaboration or stand-alone invocation task. Escalation or deletion timer settings of the completed task become active.
Collaboration and invocation task instances are also known as human and originating task instances.
The output and fault message definitions of the completed and the follow-on task must be of the same type. The types of the input messages may differ. Any output or fault message stored persistently is automatically passed to the follow-on task. The input message is passed if it is of the same type and if not specified otherwise - see the input parameter below.
The caller must be the owner or an administrator of the completed task instance. The caller must have potential-instance-creator rights on the associated application component which is inherited from the completed task instance.
tkiid
- The object ID to identify the task instance to be completed.taskModel
- The model that describes the task template from which a follow-on task is
to be created spontaneously.applicationName
- The name of the enterprise application that contains the message
or business calendar definitions used in the TaskModel.
If the message definitions are simple types only or if you do not use a business
calendar, null may be specified.input
- An optional input message for the follow-on task. If not specified,
the input message of the completed task is passed to the follow-on task provided
that they are of the same type.
Note that an object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
FaultMessageDefinitionDoesNotMatchException
FollowOnTasksNotSupportedException
IdWrongFormatException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
OutputMessageDefinitionDoesNotMatchException
ParameterNullException
com.ibm.task.plugins.TaskDeploymentException
com.ibm.task.plugins.TELValidationException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
ClientObjectWrapper createAndCallTask(java.lang.String name, java.lang.String namespace, ClientObjectWrapper input) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, FaultReplyException, InvalidApplicationStateException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, SCAServiceAccessFailureException, SCAServiceResultErrorException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
An invocation task instance is also known as originating task instance.
This method returns only when the execution of the task finishes with the result of execution. If a fault occurs, an exception is thrown. The service that is called must be a two-way operation. Otherwise, SCAServiceAccessFailureException is thrown.
The caller must be a potential instance creator or an administrator of the task template.
name
- The name of the task template from which an instance is to be created
and executed. The currently valid template is then instantiated. A WrongStateException
is thrown when the currently valid template is stopped.namespace
- The namespace of the task template.input
- The input message.
Note that the object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
FaultReplyException
InvalidApplicationStateException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
SCAServiceAccessFailureException
SCAServiceResultErrorException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
TKIID createAndStartTask(java.lang.String name, java.lang.String namespace, ClientObjectWrapper input, ReplyHandlerWrapper replyHandler) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, InvalidApplicationStateException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, SCAServiceAccessFailureException, SCAServiceResultErrorException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be a potential instance creator or an administrator of the task template. The caller becomes the originator of the task. When the task is an invocation aka originating task, then the caller also becomes the starter of the task.
name
- The name of the task template from which an instance is to be created
and started. The currently valid template is then instantiated. A WrongStateException
is thrown when the currently valid template is stopped.namespace
- The namespace of the task template.input
- The input message.
Note that the object wrapped by the ClientObjectWrapper must be serializable.replyHandler
- The reply handler to be used in order to send the result of execution
automatically back to the
caller. "null" must be specified if no reply handler is to be used.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
InvalidApplicationStateException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
SCAServiceAccessFailureException
SCAServiceResultErrorException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
TKIID createAndStartTask(TaskModel taskModel, java.lang.String applicationName, java.lang.String parentContext, ClientObjectWrapper input, ReplyHandlerWrapper replyHandler) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, IdWrongTypeException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, WrongMessageTypeException, UnexpectedFailureException, com.ibm.task.plugins.TaskDeploymentException, com.ibm.task.plugins.TELValidationException, CommunicationException
The caller must have potential-instance-creator rights on the associated application component. The caller becomes the originator of the new task.
taskModel
- The model that describes the task instance to be created spontaneously.applicationName
- The name of the enterprise application that contains the message
or business calendar definitions used in the TaskModel.
If the message definitions are simple types only or if you do not use a business
calendar, null may be specified.parentContext
- The object ID (ACOID) or the name of the application component
to be associated with the newly created task instance.input
- The input message.
Note that the object wrapped by the ClientObjectWrapper must be serializable.replyHandler
- The reply handler to be used in order to send the result of execution
automatically back to the
caller. "null" must be specified if no reply handler is to be used.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
IdWrongTypeException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
WrongMessageTypeException
UnexpectedFailureException
com.ibm.task.plugins.TaskDeploymentException
com.ibm.task.plugins.TELValidationException
TKIID createAndStartTaskAsSubTask(java.lang.String name, java.lang.String namespace, java.lang.String parentTaskID, ClientObjectWrapper input) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, IdWrongFormatException, IdWrongTypeException, InvalidApplicationStateException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, SCAServiceAccessFailureException, SCAServiceResultErrorException, SubTasksNotSupportedException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The subtask created must be a collaboration or stand-alone invocation task. An invocation task must be derived from a task template that has not been created spontaneously. The parent task instance must be a collaboration or to-do task in the claimed state. It can be escalated or already waiting for a subtask. It can, however, not be suspended.
Note that collaboration, invocation, and to-do task instances are also known as human, originating, and participating task instances.
A subtask can only
be created when the parent task supports subtask creation - refer to Task
to
view the task instance properties.
The caller must be a potential instance creator or an administrator of the subtask template and an owner or administrator of the parent task instance. The caller becomes the originator of the subtask. When the subtask is an invocation aka originating task, then the caller also becomes the starter of the task.
name
- The name of the task template from which the subtask is to be created
and started. The currently valid template is then instantiated. A WrongStateException
is thrown when the currently valid template is stopped.namespace
- The namespace of the task template.parentTaskID
- A string representation of the task instance ID that identifies
the parent task instance.input
- The input message.
Note that the object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
IdWrongTypeException
InvalidApplicationStateException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
SCAServiceAccessFailureException
SCAServiceResultErrorException
SubTasksNotSupportedException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
TKIID createAndStartTaskAsSubTask(java.lang.String name, java.lang.String namespace, TKIID parentTaskID, ClientObjectWrapper input) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, IdWrongFormatException, InvalidApplicationStateException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, SCAServiceAccessFailureException, SCAServiceResultErrorException, SubTasksNotSupportedException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The subtask created must be a collaboration or stand-alone invocation task. An invocation task must be derived from a task template that has not been created spontaneously. The parent task instance must be a collaboration or to-do task in the claimed state. It can be escalated or already waiting for a subtask. It can, however, not be suspended.
Note that collaboration, invocation, and to-do task instances are also known as human, originating, and participating task instances.
A subtask can only
be created when the parent task supports subtask creation - refer to Task
to
view the task instance properties.
The caller must be a potential instance creator or an administrator of the subtask template and an owner or administrator of the parent task instance. The caller becomes the originator of the subtask. When the subtask is an invocation aka originating task, then the caller also becomes the starter of the task.
name
- The name of the task template from which the subtask is to be created
and started. The currently valid template is then instantiated. A WrongStateException
is thrown when the currently valid template is stopped.namespace
- The namespace of the task template.parentTaskID
- The task instance ID that identifies the parent task instance.input
- The input message.
Note that the object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
InvalidApplicationStateException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
SCAServiceAccessFailureException
SCAServiceResultErrorException
SubTasksNotSupportedException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
TKIID createAndStartTaskAsSubTask(TaskModel taskModel, java.lang.String applicationName, java.lang.String parentTaskID, ClientObjectWrapper input) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, IdWrongFormatException, IdWrongTypeException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, SCAServiceAccessFailureException, SCAServiceResultErrorException, SubTasksNotSupportedException, com.ibm.task.plugins.TaskDeploymentException, com.ibm.task.plugins.TELValidationException, WrongMessageTypeException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The subtask created must be a collaboration or stand-alone invocation task. The parent task instance must be a collaboration or to-do task in the claimed state.
Collaboration, invocation, and to-do task instances are also known as human, originating, and participating task instances.
A subtask can only
be created when the parent task supports subtask creation - refer to Task
to
view the task instance properties.
The caller must have potential-instance-creator rights on the associated application component and be an owner or administrator of the parent task instance. The caller becomes the originator of the subtask. When the subtask is an invocation aka originating task, then the caller also becomes the starter of the task. The subtask inherits the context of the parent.
taskModel
- The model that describes the subtask to be created spontaneously.applicationName
- The name of the enterprise application that contains the message
or business calendar definitions used in the TaskModel.
If the message definitions are simple types only or if you do not use a business
calendar, null may be specified.parentTaskID
- Astring representation of the task instance ID that identifies the parent
task instance.input
- The input message.
Note that the object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
SCAServiceAccessFailureException
SCAServiceResultErrorException
SubTasksNotSupportedException
com.ibm.task.plugins.TaskDeploymentException
com.ibm.task.plugins.TELValidationException
WrongMessageTypeException
WrongKindException
WrongStateException
UnexpectedFailureException
TKIID createAndStartTaskAsSubTask(TaskModel taskModel, java.lang.String applicationName, TKIID parentTaskID, ClientObjectWrapper input) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, IdWrongFormatException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, SCAServiceAccessFailureException, SCAServiceResultErrorException, SubTasksNotSupportedException, com.ibm.task.plugins.TaskDeploymentException, com.ibm.task.plugins.TELValidationException, WrongMessageTypeException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The subtask created must be a collaboration or stand-alone invocation task. The parent task instance must be a collaboration or to-do task in the claimed state.
Collaboration, invocation, and to-do task instances are also known as human, originating, and participating task instances.
A subtask can only
be created when the parent task supports subtask creation - refer to Task
to
view the task instance properties.
The caller must have potential-instance-creator rights on the associated application component and be an owner or administrator of the parent task instance. The caller becomes the originator of the subtask. When the subtask is an invocation aka originating task, then the caller also becomes the starter of the task. The subtask inherits the context of the parent.
taskModel
- The model that describes the subtask to be created spontaneously.applicationName
- The name of the enterprise application that contains the message
or business calendar definitions used in the TaskModel.
If the message definitions are simple types only or if you do not use a business
calendar, null may be specified.parentTaskID
- The task instance ID that identifies the parent task instance.input
- The input message.
Note that the object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
SCAServiceAccessFailureException
SCAServiceResultErrorException
SubTasksNotSupportedException
com.ibm.task.plugins.TaskDeploymentException
com.ibm.task.plugins.TELValidationException
WrongMessageTypeException
WrongKindException
WrongStateException
UnexpectedFailureException
ClientObjectWrapper createFaultMessage(java.lang.String tkiid, java.lang.String faultName) throws IdWrongFormatException, IdWrongTypeException, InvalidQNameException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
complete
.
The caller must be the owner, an editor, or an administrator of the task instance.
tkiid
- A string representation of the task instance ID that
is used to identify the task instance.faultName
- The name of the fault for which a message is to be created. The fault name
must identify a fault that is defined for the task instance. Refer
to getFaultNames
.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
InvalidQNameException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
ClientObjectWrapper createFaultMessage(TKIID tkiid, java.lang.String faultName) throws IdWrongFormatException, InvalidQNameException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
complete
.
The caller must be the owner, an editor, or an administrator of the task instance.
tkiid
- The task instance ID that is used to identify the task instance.faultName
- The name of the fault fot which a message is to be created. The fault name
must identify a fault that is defined for the task instance. Refer
to getFaultNames
.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
InvalidQNameException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
ClientObjectWrapper createInputMessage(java.lang.String identifier) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be the owner, a potential starter, the originator, or an administrator of the task instance.
identifier
- A string representation of the task instance or template ID
that is used to identify the task instance or template.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
ClientObjectWrapper createInputMessage(TKIID tkiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be the owner, a potential starter, the originator, or an administrator of the task instance.
tkiid
- The task instance ID that is used to identify the task instance.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
ClientObjectWrapper createInputMessage(TKTID tktid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be the owner, a potential starter, the originator, or an administrator of the task instance.
tktid
- The task template ID that is used to identify the task template.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
ClientObjectWrapper createMessage(java.lang.String tkiid, java.lang.String messageTypeName) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, UnexpectedFailureException, CommunicationException
createInputMessage
,
createOutputMessage
,
createFaultMessage
.
The caller must have at least reader authority for the task instance.
tkiid
- A String representation of the task instance ID that is used
to identify the task instance for which a message is to be created.messageTypeName
- The name of the message type for which a message is to be created.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
ClientObjectWrapper createMessage(TKIID tkiid, java.lang.String messageTypeName) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, UnexpectedFailureException, CommunicationException
createInputMessage
,
createOutputMessage
,
createFaultMessage
.
The caller must have at least reader authority for the task instance.
tkiid
- The object ID of the task instance for which a message is to be created.messageTypeName
- The name of the message type for which a message is to be created.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
ClientObjectWrapper createOutputMessage(java.lang.String tkiid) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be the owner, an editor, or an administrator of the task instance.
tkiid
- A string representation of the task instance ID
that is used to identify the task instance.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
ClientObjectWrapper createOutputMessage(TKIID tkiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be the owner, an editor, or an administrator of the task instance.
tkiid
- The task instance ID that is used to identify the task instance.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void createStoredQuery(java.lang.String storedQueryName, java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer threshold, java.util.TimeZone timeZone) throws InvalidLengthException, NotAuthorizedException, ParameterNullException, StoredQueryNameNotUniqueException, UnexpectedFailureException, CommunicationException
A stored query represents a set of selected object properties. The number of tuples in the set can be restricted by a filter or threshold. When executing the stored query, that set can additionally be restricted by specifying a starting tuple parameter.
To allow for the re-use of stored queries, parameters can be specified in the where-clause so that, for example, the owner of tasks can be specified when the stored query is executed.
Besides defining filtering criteria, sort criteria can be defined that are applied on the server. Sorting on the server means that the locale of the server is used.
Specify the parameters of the query definition, the select-, where-, and order-by-clause, using SQL based on the published views. Execution of the query can thus be shifted to SQL and becomes portable and optimizable.
Note, however, when you use a combination of the order-by-clause, threshold, or skipTuples parameters, the tuples returned depend on your database system. For example, some database systems order all records and then return the requested number of tuples. Other database systems first take the requested number of tuples and then apply the order criteria.
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 or which can be transitively reached via your work item. As a rule of thumb, all objects except task templates can be reached via work items. This means that you cannot use task template properties only but that you must specify a non task template property in the select- or where-clause.
Note that a task system administrator has special rights and can retrieve information on objects associated to other users. When the stored query is executed by a task system administrator, the selected properties of all objects for which there are work items are returned, no matter whether there is a personally owned work item or another user's work item.
Although stored query definitions are stored persistently, object properties contained in
the result set are assembled dynamically when they are queried.
Refer to query
for the execution of stored queries.
When a stored query definition needs to be updated, it must be deleted and recreated -
refer to deleteStoredQuery
for the deletion of
stored queries.
storedQueryName
- The name of the stored query to be created; must not be greater than 64
bytes in UTF-8 format. The name must be unique.selectClause
- Describes the query result that is returned when the stored query is executed.
Its syntax is an SQL select-clause.
It either declares a list of names that identify the object properties (columns of the result) to be returned or it specifies the COUNT keyword. Aggregation functions like AVG(), SUM(), MIN(), and MAX() are not supported.
Each part of the select-clause separated by a comma must specify a property from the published views - see the InfoCenter for details.
To select properties of name-value pairs like custom properties, add a one-digit suffix (0-9) to the view name. For example, "TASK_CPROP1.STRING_VALUE, TASK_CPROP2.STRING_VALUE".
To count the number of potentially qualifying tuples, use the COUNT keyword. For example, to count the number of task instance IDs that satisfy the where-clause, specify a select-clause such as "COUNT(DISTINCT TASK.TKIID)". If you use the more generic "COUNT(*)", then you must specify a where-clause so that the tuples to be counted can be determined. For example, to count all tasks, specify a where-clause such as "TASK.TKIID=TASK.TKIID" that always evaluates to true.
A selectClause must not be greater than 512 bytes in UTF-8 format.
The QueryResultSet contains columns in the same order as specified in the selectClause. If tuples are to be counted, an int value is returned (row 1, column 1).
whereClause
- Specifies the search condition that is applied when the stored query is executed.
Its syntax is an SQL where-clause. The following rules apply:
query
.
If a filter is not to be applied, null must be specified.
A whereClause must not be greater than 2047 bytes in UTF-8 format.
orderByClause
- Orders the result of the stored query execution by the values of the columns you identify.
Its syntax is an SQL order-by-clause. Each part of the order-by-clause separated by a comma
must specify a property from the published views.
If you identify more that one property, the stored query execution result is ordered by the values of the first property you identify, then by the values of the second property, and so on.
If sort criteria are not to be applied, null must be specified. An orderByClause must not be greater than 254 bytes in UTF-8 format.
Note that sort criteria are applied on the server, that is, the locale of the server is used for sorting.
threshold
- The maximum number of stored query execution result tuples to be returned from the
server to the client. If a threshold is not to be applied, null must be specified.timeZone
- Specifies the time zone of the timestamp constants in the whereClause
respectively the time zone for the timestamp values returned.
If a timezone is not specified, UTC is assumed.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
InvalidLengthException
NotAuthorizedException
ParameterNullException
StoredQueryNameNotUniqueException
UnexpectedFailureException
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) throws InvalidLengthException, InvalidParameterException, ParameterNullException, StoredQueryNameNotUniqueException, UnexpectedFailureException, CommunicationException
A stored query represents a set of selected object properties. The number of tuples in the set can be restricted by a filter or threshold. When executing the stored query, that set can additionally be restricted by specifying a starting tuple parameter.
To allow for the re-use of stored queries, parameters can be specified in the where-clause so that, for example, the owner of tasks can be specified when the stored query is executed.
Besides defining filtering criteria, sort criteria can be defined that are applied on the server. This means that the locale of the server is used for sorting.
Specify the parameters of the query definition, the select-, where-, and order-by-clause, using SQL based on the published views. Execution of the query can thus be shifted to SQL and becomes portable and optimizable.
Note, however, when you use a combination of the order-by-clause, threshold, or skipTuples parameters, the tuples returned depend on your database system. For example, some database systems order all records and then return the requested number of tuples. Other database systems first take the requested number of tuples and then apply the order criteria.
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 or which can be transitively reached via your work item. As a rule of thumb, all objects except task templates can be reached via work items. This means that you cannot use task template properties only but that you must specify a non task template property in the select- or where-clause.
Note that a task system administrator has special rights and can retrieve information on objects associated to other users. When the stored query is executed by a task system administrator, the selected properties of all objects for which there are work items are returned, no matter whether there is a personally owned work item or another user's work item.
Although stored query definitions are stored persistently, object properties contained in
the result set are assembled dynamically when they are queried.
Refer to query
for the execution of stored queries.
When a stored query definition needs to be updated, it must be deleted and recreated -
refer to deleteStoredQuery
for the deletion of
stored queries.
storedQueryName
- The name of the stored query to be created; must not be greater than 64
bytes in UTF-8 format. The name must be unique.selectClause
- Describes the query result that is returned when the stored query is executed.
Its syntax is an SQL select-clause.
It either declares a list of names that identify the object properties (columns of the result) to be returned or it specifies the COUNT keyword. Aggregation functions like AVG(), SUM(), MIN(), and MAX() are not supported.
Each part of the select-clause separated by a comma must specify a property from the published views - see the InfoCenter for details.
To select properties of name-value pairs like custom properties, add a one-digit suffix (0-9) to the view name. For example, "TASK_CPROP1.STRING_VALUE, TASK_CPROP2.STRING_VALUE".
To count the number of potentially qualifying tuples, use the COUNT keyword. For example, to count the number of task instance IDs that satisfy the where-clause, specify a select-clause such as "COUNT(DISTINCT TASK.TKIID)". If you use the more generic "COUNT(*)", then you must specify a where-clause so that the tuples to be counted can be determined. For example, to count all tasks, specify a where-clause such as "TASK.TKIID=TASK.TKIID" that always evaluates to true.
A selectClause must not be greater than 512 bytes in UTF-8 format.
The QueryResultSet contains columns in the same order as specified in the selectClause. If tuples are to be counted, an int value is returned (row 1, column 1).
whereClause
- Specifies the search condition that is applied when the stored query is executed.
Its syntax is an SQL where-clause. The following rules apply:
query
.
If a filter is not to be applied, null must be specified.
A whereClause must not be greater than 2047 bytes in UTF-8 format.
orderByClause
- Orders the result of the stored query execution by the values of the columns you identify.
Its syntax is an SQL order-by-clause. Each part of the order-by-clause separated by a comma
must specify a property from the published views.
If you identify more that one property, the stored query execution result is ordered by the values of the first property you identify, then by the values of the second property, and so on.
If sort criteria are not to be applied, null must be specified. An orderByClause must not be greater than 254 bytes in UTF-8 format.
Note that sort criteria are applied on the server, that is, the locale of the server is used for sorting.
threshold
- The maximum number of stored query execution result tuples to be returned from the
server to the client. If a threshold is not to be applied, null must be specified.timeZone
- Specifies the time zone of the timestamp constants in the whereClause
respectively the time zone for the timestamp values returned.
If a timezone is not specified, UTC is assumed.storedQueryProperties
- Specifies user-defined properties to be attached to the stored query. Must
be a list of StoredQueryProperty objects - see StoredQueryProperty
.
If no properties are to be attached, null must be passed.clientType
- A user-defined client type to specify the creator of the stored query,
for example, Web, Portal, or Custom.
The client type must not be greater than 128 bytes in UTF-8 format.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
InvalidLengthException
InvalidParameterException
ParameterNullException
StoredQueryNameNotUniqueException
UnexpectedFailureException
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) throws InvalidLengthException, InvalidParameterException, NotAuthorizedException, ParameterNullException, StoredQueryNameNotUniqueException, UnexpectedFailureException, CommunicationException
A regular user can only create stored queries that are available for his personal usage. A task system administrator can create stored queries that are available for public usage or for the usage of the specified person.
A stored query represents a set of selected object properties. The number of tuples in the set can be restricted by a filter or threshold. When executing the stored query, that set can additionally be restricted by specifying a starting tuple parameter.
To allow for the re-use of stored queries, parameters can be specified in the where-clause so that, for example, the owner of tasks can be specified when the stored query is executed.
Besides defining filtering criteria, sort criteria can be defined that are applied on the server. This means that the locale of the server is used for sorting.
Specify the parameters of the query definition, the select-, where-, and order-by-clause, using SQL based on the published views. Execution of the query can thus be shifted to SQL and becomes portable and optimizable.
Note, however, when you use a combination of the order-by-clause, threshold, or skipTuples parameters, the tuples returned depend on your database system. For example, some database systems order all records and then return the requested number of tuples. Other database systems first take the requested number of tuples and then apply the order criteria.
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, or which can be transitively reached via your work item. As a rule of thumb, all objects except task templates can be reached via work items. This means that you cannot use task template properties only but that you must specify a non task template property in the select- or where-clause.
Note that a task system administrator has special rights and can retrieve information on objects associated to other users. When the stored query is executed by a task system administrator, the selected properties of all objects for which there are work items are returned, no matter whether there is a personally owned work item or another user's work item.
Although stored query definitions are stored persistently, object properties contained in
the result set are assembled dynamically when they are queried.
Refer to query
for the execution of stored queries.
When a stored query definition needs to be updated, it must be deleted and recreated -
refer to deleteStoredQuery
for the deletion of
stored queries.
userID
- The name of a user who is to become the owner of the stored query. Null means
that a public stored query is created.storedQueryName
- The name of the stored query to be created; must not be greater than 64
bytes in UTF-8 format. The name must be unique.selectClause
- Describes the query result that is returned when the stored query is executed.
Its syntax is an SQL select-clause.
It either declares a list of names that identify the object properties (columns of the result) to be returned or it specifies the COUNT keyword. Aggregation functions like AVG(), SUM(), MIN(), and MAX() are not supported.
Each part of the select-clause separated by a comma must specify a property from the published views - see the InfoCenter for details.
To select properties of name-value pairs like custom properties, add a one-digit suffix (0-9) to the view name. For example, "TASK_CPROP1.STRING_VALUE, TASK_CPROP2.STRING_VALUE".
To count the number of potentially qualifying tuples, use the COUNT keyword. For example, to count the number of task instance IDs that satisfy the where-clause, specify a select-clause such as "COUNT(DISTINCT TASK.TKIID)". If you use the more generic "COUNT(*)", then you must specify a where-clause so that the tuples to be counted can be determined. For example, to count all tasks, specify a where-clause such as "TASK.TKIID=TASK.TKIID" that always evaluates to true.
A selectClause must not be greater than 512 bytes in UTF-8 format.
The QueryResultSet contains columns in the same order as specified in the selectClause. If tuples are to be counted, an int value is returned (row 1, column 1).
whereClause
- Specifies the search condition that is applied when the stored query is executed.
Its syntax is an SQL where-clause. The following rules apply:
query
.
If a filter is not to be applied, null must be specified.
A whereClause must not be greater than 2047 bytes in UTF-8 format.
orderByClause
- Orders the result of the stored query execution by the values of the columns you identify.
Its syntax is an SQL order-by-clause. Each part of the order-by-clause separated by a comma
must specify a property from the published views.
If you identify more that one property, the stored query execution result is ordered by the values of the first property you identify, then by the values of the second property, and so on.
If sort criteria are not to be applied, null must be specified. An orderByClause must not be greater than 254 bytes in UTF-8 format.
Note that sort criteria are applied on the server, that is, the locale of the server is used for sorting.
threshold
- The maximum number of stored query execution result tuples to be returned from the
server to the client. If a threshold is not to be applied, null must be specified.timeZone
- Specifies the time zone of the timestamp constants in the whereClause
respectively the time zone for the timestamp values returned.
If a timezone is not specified, UTC is assumed.storedQueryProperties
- Specifies user-defined properties to be attached to the stored query. Must
be a list of StoredQueryProperty objects - see StoredQueryProperty
.
If no properties are to be attached, null must be passed.clientType
- A user-defined client type to specify the creator of the stored query,
for example, Web, Portal, or Custom.
The client type must not be greater than 128 bytes in UTF-8 format.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
InvalidLengthException
InvalidParameterException
NotAuthorizedException
ParameterNullException
StoredQueryNameNotUniqueException
UnexpectedFailureException
TKIID createTask(java.lang.String name, java.lang.String namespace) throws ApplicationVetoException, CannotCreateWorkItemException, InvalidApplicationStateException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be a potential instance creator or an administrator of the task template. The task must not be inline.
name
- The name of the task template from which an instance is to be created.namespace
- The namespace of the task template.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
CannotCreateWorkItemException
InvalidApplicationStateException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
TKIID createTask(java.lang.String name, java.lang.String namespace, ClientObjectWrapper input) throws ApplicationVetoException, CannotCreateWorkItemException, InvalidApplicationStateException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be a potential instance creator or an administrator of the task template. The task must not be inline.
name
- The name of the task template from which an instance is to be created.namespace
- The namespace of the task template.input
- The input message to be used when the task is run.
The object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
CannotCreateWorkItemException
InvalidApplicationStateException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
TKIID createTask(TaskModel taskModel, java.lang.String applicationName, java.lang.String parentContext) throws ApplicationVetoException, CannotCreateWorkItemException, IdWrongTypeException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, UnexpectedFailureException, com.ibm.task.plugins.TaskDeploymentException, com.ibm.task.plugins.TELValidationException, CommunicationException
The caller must have potential-instance-creator rights on the associated application component.
taskModel
- The model that describes the task instance to be created spontaneously.applicationName
- The name of the enterprise application that contains the message
or business calendar definitions used in the TaskModel.
If the message definitions are simple types only or if you do not use a business
calendar, null may be specified.parentContext
- The object ID (ACOID) or the name of the application component
to be associated with the task instance.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
CannotCreateWorkItemException
IdWrongTypeException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
com.ibm.task.plugins.TaskDeploymentException
com.ibm.task.plugins.TELValidationException
TKIID createTask(TaskModel taskModel, java.lang.String applicationName, java.lang.String parentContext, ClientObjectWrapper input) throws ApplicationVetoException, CannotCreateWorkItemException, IdWrongTypeException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongMessageTypeException, UnexpectedFailureException, com.ibm.task.plugins.TaskDeploymentException, com.ibm.task.plugins.TELValidationException, CommunicationException
The caller must have potential-instance-creator rights on the associated application component.
taskModel
- The model that describes the task instance to be created spontaneously.applicationName
- The name of the enterprise application that contains the message
or business calendar definitions used in the TaskModel.
If the message definitions are simple types only or if you do not use a business
calendar, null may be specified.parentContext
- The object ID (ACOID) or the name of the application component
to be associated with the task instance.input
- The input message to be used when the task is run.
The object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
CannotCreateWorkItemException
IdWrongTypeException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongMessageTypeException
UnexpectedFailureException
com.ibm.task.plugins.TaskDeploymentException
com.ibm.task.plugins.TELValidationException
TKTID createTaskTemplate(TaskModel taskModel, java.lang.String applicationName) throws ApplicationVetoException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, UnexpectedFailureException, com.ibm.task.plugins.TaskDeploymentException, com.ibm.task.plugins.TELValidationException, CommunicationException
The caller must have potential-instance-creator rights on the associated application component.
taskModel
- The model that describes the task template to be created spontaneously.applicationName
- The name of the enterprise application that contains the message
or business calendar definitions used in the TaskModel.
If the message definitions are simple types only or if you do not use a business
calendar, null may be specified.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
com.ibm.task.plugins.TaskDeploymentException
com.ibm.task.plugins.TELValidationException
void createWorkItem(java.lang.String identifier, int assignmentReason, java.lang.String userID) throws ApplicationVetoException, EverybodyWorkItemException, GroupWorkItemException, IdWrongFormatException, IdWrongTypeException, InvalidAssignmentReasonException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, TaskDelegationNotSupportedException, WorkItemManagerException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be an administrator. As long as the task is inactive, the originator of the task can also create new work items.
The following rules apply for the creation work items:
identifier
- A string representation of the task or escalation instance ID that is used to identify
the object for which a new work item is to be created.assignmentReason
- The reason why the work item is assigned - refer to
WorkItem.getAssignmentReason
.userID
- The user for which a work item is to be created.
It is checked whether the user exists but the check may be executed case insensitively.
The check can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments'
custom property of the Human Task Manager configuration to 'true'.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
EverybodyWorkItemException
GroupWorkItemException
IdWrongFormatException
IdWrongTypeException
InvalidAssignmentReasonException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
TaskDelegationNotSupportedException
WorkItemManagerException
WrongKindException
WrongStateException
UnexpectedFailureException
void createWorkItem(TKIID tkiid, int assignmentReason, java.lang.String userID) throws ApplicationVetoException, EverybodyWorkItemException, GroupWorkItemException, IdWrongFormatException, InvalidAssignmentReasonException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, TaskDelegationNotSupportedException, WorkItemManagerException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be an administrator when the task is active. As long as the task is inactive, the originator of the task can also create new work items.
The following rules apply for the creation of additional work items:
tkiid
- The object ID of the task instance the new work item should belong to.assignmentReason
- The reason why the work item is assigned - refer to
WorkItem.getAssignmentReason
.userID
- The user the work item should belong to.
It is checked whether the user exists but the check may be executed case insensitively.
The check can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments'
custom property of the Human Task Manager configuration to 'true'.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
EverybodyWorkItemException
GroupWorkItemException
IdWrongFormatException
InvalidAssignmentReasonException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
TaskDelegationNotSupportedException
WorkItemManagerException
WrongKindException
WrongStateException
UnexpectedFailureException
void createWorkItem(ESIID esiid, int assignmentReason, java.lang.String userID) throws ApplicationVetoException, EverybodyWorkItemException, GroupWorkItemException, IdWrongFormatException, InvalidAssignmentReasonException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, TaskDelegationNotSupportedException, WorkItemManagerException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be an administrator. Additional "escalation receiver" work items can only be created when the task is escalated.
esiid
- The object ID of the escalation instance for which a new work item is to be created.assignmentReason
- The reason why the work item is assigned - refer to
WorkItem.getAssignmentReason
. Valid values are
WorkItem.REASON_ESCALATION_RECEIVER, WorkItem.REASON_READER, and WorkItem.REASON_ADMINISTRATOR.userID
- The user for which a new work item is to be created.
It is checked whether the user exists but the check may be executed case insensitively.
The check can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments'
custom property of the Human Task Manager configuration to 'true'.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
EverybodyWorkItemException
GroupWorkItemException
IdWrongFormatException
InvalidAssignmentReasonException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
TaskDelegationNotSupportedException
WorkItemManagerException
WrongKindException
WrongStateException
UnexpectedFailureException
void delete(java.lang.String tkiid) throws ApplicationVetoException, ChildTaskInstanceActiveException, IdWrongFormatException, IdWrongTypeException, IsNotTopLevelTaskException, NotAuthorizedException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task must be in the inactive, terminated, expired, finished, or failed state. It can be escalated or suspended.
The caller must have administrative rights or be the originator of the task. An originator can only delete an inactive task.
tkiid
- A string representation of the task instance ID
that is used to identify the task instance.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
ChildTaskInstanceActiveException
IdWrongFormatException
IdWrongTypeException
IsNotTopLevelTaskException
NotAuthorizedException
WrongKindException
WrongStateException
UnexpectedFailureException
void delete(TKIID tkiid) throws ApplicationVetoException, IdWrongFormatException, IsNotTopLevelTaskException, NotAuthorizedException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task must be in the inactive, terminated, expired, finished, or failed state. It can be escalated or suspended.
The caller must have administrative rights or be the originator of the task. An originator can only delete an inactive task.
tkiid
- The task instance ID that is used to identify the task instance.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IsNotTopLevelTaskException
NotAuthorizedException
WrongKindException
WrongStateException
UnexpectedFailureException
void delete(java.lang.String identifier, boolean deleteInstances) throws ApplicationVetoException, ChildTaskInstanceActiveException, IdWrongFormatException, IdWrongTypeException, IsNotAdHocException, NotAuthorizedException, ObjectDoesNotExistException, RunningInstancesException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task template must be in the stopped state to prevent new instances from being created. No task instances may exist that are derived from this template unless deletion of the instances is requested.
The caller must have administrative rights.
identifier
- A string representation of the task template ID
that is used to identify the task template to be deleted.deleteInstances
- Specifies whether all instances that are derived from this template are to be deleted
together with the template.
True states that all derived instances are to be deleted.
False states that derived instances are not to be deleted; if instances exist, a
RunningInstancesException
is thrown.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
ChildTaskInstanceActiveException
IdWrongFormatException
IdWrongTypeException
IsNotAdHocException
NotAuthorizedException
ObjectDoesNotExistException
RunningInstancesException
WrongKindException
WrongStateException
UnexpectedFailureException
void delete(TKTID tktid, boolean deleteInstances) throws ApplicationVetoException, ChildTaskInstanceActiveException, IdWrongFormatException, IsNotAdHocException, NotAuthorizedException, ObjectDoesNotExistException, RunningInstancesException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task template must be in the stopped state to prevent new instances from being created. No task instances may exist that are derived from this template unless deletion of the instances is requested.
The caller must have administrative rights.
tktid
- The task template ID that is used to identify the task template to be deleted.deleteInstances
- Specifies whether all instances that are derived from this template are to be deleted
together with the template.
True states that all derived instances are to be deleted.
False states that derived instances are not to be deleted; if instances exist, a
RunningInstancesException
is thrown.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
ChildTaskInstanceActiveException
IdWrongFormatException
IsNotAdHocException
NotAuthorizedException
ObjectDoesNotExistException
RunningInstancesException
WrongKindException
WrongStateException
UnexpectedFailureException
void deleteStoredQuery(java.lang.String storedQueryName) throws NotAuthorizedException, ParameterNullException, UnexpectedFailureException, CommunicationException
No error is signalled when the specified stored query does no longer exist.
Refer to createStoredQuery
for
the creation of stored queries.
storedQueryName
- The name of the stored query to be deleted -
refer to getStoredQueryNames
for the retrieval of existing stored query names.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
NotAuthorizedException
ParameterNullException
UnexpectedFailureException
void deleteStoredQuery(java.lang.String userID, java.lang.String storedQueryName) throws NotAuthorizedException, ParameterNullException, UnexpectedFailureException, CommunicationException
A regular user can only delete stored queries that are available for his personal usage. A task system administrator can also delete stored queries that are available for the usage of the specified person.
No error is signalled when the specified stored query does no longer exist.
Refer to createStoredQuery
for
the creation of stored queries.
userID
- The name of the user who is the owner of the stored query.storedQueryName
- The name of the stored query to be deleted -
refer to getStoredQueryNames
for the retrieval of existing stored query names.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
NotAuthorizedException
ParameterNullException
UnexpectedFailureException
void deleteWorkItem(java.lang.String identifier, int assignmentReason, java.lang.String userID) throws ApplicationVetoException, EverybodyWorkItemException, GroupWorkItemException, IdWrongFormatException, IdWrongTypeException, InvalidAssignmentReasonException, InvalidLengthException, LastAdminWorkItemException, NotAuthorizedException, WorkItemDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, TaskDelegationNotSupportedException, WorkItemManagerException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be an administrator for the deletion of work items for escalation instances or when the task is active. As long as the task is inactive, the originator of the task can also delete a work item.
The following rules apply for the deletion of work items:
identifier
- A string representation of the task or escalation instance ID that is used to identify
the work item to be deleted.assignmentReason
- The reason why the work item is assigned - refer to
WorkItem.getAssignmentReason
for valid values.userID
- The user the work item belongs to.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
EverybodyWorkItemException
GroupWorkItemException
IdWrongFormatException
IdWrongTypeException
InvalidAssignmentReasonException
InvalidLengthException
LastAdminWorkItemException
NotAuthorizedException
WorkItemDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
TaskDelegationNotSupportedException
WorkItemManagerException
WrongKindException
WrongStateException
UnexpectedFailureException
void deleteWorkItem(TKIID tkiid, int assignmentReason, java.lang.String userID) throws ApplicationVetoException, EverybodyWorkItemException, GroupWorkItemException, IdWrongFormatException, InvalidAssignmentReasonException, InvalidLengthException, LastAdminWorkItemException, NotAuthorizedException, WorkItemDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, TaskDelegationNotSupportedException, WorkItemManagerException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be an administrator when the task is active. As long as the task is inactive, the originator of the task can also delete a work item.
The following rules apply for the deletion of work items:
tkiid
- The ID of task instance that is used to identify the work item to be deleted.assignmentReason
- The reason why the work item is assigned - refer to
WorkItem.getAssignmentReason
.userID
- The user the work item belongs to.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
EverybodyWorkItemException
GroupWorkItemException
IdWrongFormatException
InvalidAssignmentReasonException
InvalidLengthException
LastAdminWorkItemException
NotAuthorizedException
WorkItemDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
TaskDelegationNotSupportedException
WorkItemManagerException
WrongKindException
WrongStateException
UnexpectedFailureException
void deleteWorkItem(ESIID esiid, int assignmentReason, java.lang.String userID) throws ApplicationVetoException, EverybodyWorkItemException, GroupWorkItemException, IdWrongFormatException, InvalidAssignmentReasonException, InvalidLengthException, LastAdminWorkItemException, NotAuthorizedException, WorkItemDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, TaskDelegationNotSupportedException, WorkItemManagerException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be an administrator. "Escalation receiver" work items can only be deleted when the task is escalated.
esiid
- The ID of escalation instance that is used to identify the work item to be deleted.assignmentReason
- The reason why the work item is assigned - refer to
WorkItem.getAssignmentReason
for valid values.userID
- The user the work item belongs to.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
EverybodyWorkItemException
GroupWorkItemException
IdWrongFormatException
InvalidAssignmentReasonException
InvalidLengthException
LastAdminWorkItemException
NotAuthorizedException
WorkItemDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
TaskDelegationNotSupportedException
WorkItemManagerException
WrongKindException
WrongStateException
UnexpectedFailureException
boolean getAbsence() throws StaffServiceCannotAccessVMMException, StaffServiceSubstitutionNotEnabledException, StaffServiceRuntimeException, UserDoesNotExistException, UnexpectedFailureException, CommunicationException
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
StaffServiceCannotAccessVMMException
StaffServiceSubstitutionNotEnabledException
StaffServiceRuntimeException
UserDoesNotExistException
UnexpectedFailureException
boolean getAbsence(java.lang.String userID) throws NotAuthorizedException, ParameterNullException, StaffServiceCannotAccessVMMException, StaffServiceSubstitutionNotEnabledException, StaffServiceRuntimeException, UserDoesNotExistException, UnexpectedFailureException, CommunicationException
If retrieving the absence setting is not restricted to administrators, then everybody can retrieve the absence setting of any user.
If retrieving the absence setting is restricted to administrators, then only task system monitors or task system administrators can retrieve the absence setting of arbitrary users. A user may, however, always read his/her personal setting.
userID
- The name of the user whose absence setting is to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
NotAuthorizedException
ParameterNullException
StaffServiceCannotAccessVMMException
StaffServiceSubstitutionNotEnabledException
StaffServiceRuntimeException
UserDoesNotExistException
UnexpectedFailureException
WorkItem[] getAllWorkItems(java.lang.String identifier) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
The task or escalation instance can be in any execution state.
The caller must have a work item for the task or escalation instance or be a task system administrator or task system monitor.
identifier
- The string representation of a task or escalation instance ID. The string is
used to identify the object whose work item assignments are to be retrieved.
WorkItem
to view the work item properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
WorkItem[] getAllWorkItems(ESIID esiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
The escalation instance can be in any state.
The caller must have a work item for the escalation instance or be a task system administrator or task system monitor.
esiid
- The object ID of the escalation instance. This ID is used to identify
the escalation whose work item assignments are to be retrieved.
WorkItem
to view the work item properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
WorkItem[] getAllWorkItems(TKIID tkiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
The task instance can be in any execution state.
The caller must have a work item for the task instance or be a task system administrator or task system monitor.
tkiid
- The object ID of the task instance. This ID is used to identify
the task whose work item assignments are to be retrieved.
WorkItem
to view the work item properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
boolean[][] getAvailableActionFlags(java.lang.String[] identifiers) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
TaskActions
or
EscalationActions
for possible actions.
identifiers
- An array of string representations of task or escalation instance IDs.
The task or escalation instances appear in the same order as specified.
Refer to TaskActionIndex
or
EscalationActionIndex
for index constants that can
be used to access the columns of the two-dimensional array.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
boolean[][] getAvailableActionFlags(ESIID[] esiids) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
EscalationActions
for possible actions.
esiids
- An array of escalation instance IDs.
The escalation instances appear in the same order as specified.
Refer to EscalationActionIndex
for index constants that can
be used to access the columns of the two-dimensional array.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
boolean[][] getAvailableActionFlags(TKIID[] tkiids) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
TaskActions
for possible actions.
tkiids
- An array of task instance IDs.
The task instances appear in the same order as specified.
Refer to TaskActionIndex
for index constants that can
be used to access the columns of the two-dimensional array.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
int[] getAvailableActions(java.lang.String identifier) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
TaskActions
, TaskTemplateActions
,
EscalationActions
, or
EscalationTemplateActions
for possible actions.
identifier
- The string representation of the object ID.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
int[] getAvailableActions(ESTID estid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
EscalationTemplateActions
for possible actions.
estid
- The object ID of the escalation template.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
int[] getAvailableActions(ESIID esiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
EscalationActions
for possible actions.
esiid
- The object ID of the escalation instance.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
int[] getAvailableActions(TKIID tkiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
TaskActions
for possible actions.
tkiid
- The object ID of the task instance.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
int[] getAvailableActions(TKTID tktid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
TaskTemplateActions
for possible actions.
tktid
- The object ID of the task template.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
ApplicationComponent getApplicationComponent(java.lang.String acoid) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
The caller must be the task system administrator or the task system monitor.
acoid
- A string representation of the application component ID. This is used
to identify the application component to be retrieved.
ApplicationComponent
to view the
application component properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
ApplicationComponent getApplicationComponent(ACOID acoid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
The caller must be the task system administrator or the task system monitor.
acoid
- The object ID of the application component to be retrieved.
ApplicationComponent
to view the
application component properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.lang.String getCustomProperty(java.lang.String identifier, java.lang.String propertyName) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to tasks or escalations beyond those provided and managed by the task manager.
A custom property can be retrieved in any state of a task or escalation instance. The caller must have at least reader authority for the task or escalation instance.
identifier
- A string representation of the task instance, task template, escalation instance,
or escalation template 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.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
java.lang.String getCustomProperty(ESTID estid, java.lang.String propertyName) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to escalations beyond those provided and managed by the task manager.
The caller must have at least reader authority for the escalation template.
estid
- The escalation template ID whose named
custom property is to be retrieved.propertyName
- The name of the custom property for which
the value is to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
java.lang.String getCustomProperty(ESIID esiid, java.lang.String propertyName) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to an escalation beyond those provided and managed by the task manager.
A custom property can be retrieved in any state of the escalation instance. The caller must have at least reader authority for the escalation instance.
esiid
- The escalation instance ID whose named
custom property is to be retrieved.propertyName
- The name of the custom property for which
the value is to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
java.lang.String getCustomProperty(TKTID tktid, java.lang.String propertyName) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to tasks beyond those provided and managed by the task manager.
The caller must have at least reader authority for the task template.
tktid
- The task template ID whose named
custom property is to be retrieved.propertyName
- The name of the custom property for which
the value is to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
java.lang.String getCustomProperty(TKIID tkiid, java.lang.String propertyName) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to a task beyond those provided and managed by the task manager.
A custom properties can be retrieved in any state of the task instance. The caller must have at least reader authority for the task instance.
tkiid
- The task instance ID whose named
custom property is to be retrieved.propertyName
- The name of the custom property for which
the value is to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
java.util.List getCustomPropertyInfo(int objectType, java.lang.String nameFilter, java.lang.Integer threshold) throws InvalidParameterException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to objects beyond those provided and managed by the Human Task Manager.
Besides specifying an object type, you can specify a threshold or a filter to reduce the number of custom property information returned.
objectType
- An indicator that specifies for which object type custom property information
is to be retrieved. If there are multiple custom properties with the same name for the
same object type, a single information entry is returned.nameFilter
- A filter on the names of custom properties.
A SQL LIKE predicate is applied to the custom property names.threshold
- Specifies the maximum number of custom property information entries to be returned from the
server to the client. If a threshold is not to be applied, null must be specified.
CustomPropertyInfo
objects.
For instances, information is only returned for custom properties the logged-on
user is authorized to read.
The list is empty if there are no custom properties for the specified object type the user is authorized to read.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
InvalidParameterException
WorkItemManagerException
UnexpectedFailureException
java.util.List getCustomPropertyNames(java.lang.String identifier) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to tasks or escalations beyond those provided and managed by the task manager.
Custom properties names can be retrieved in any state of a task or escalation instance. The caller must have at least reader authority for the task or escalation instance.
identifier
- A string representation of the task instance, task template, escalation
instance, or escalation template ID. This
string is used to identify the object for which the
custom property names are to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.util.List getCustomPropertyNames(ESTID estid) throws NotAuthorizedException, IdWrongFormatException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to escalations beyond those provided and managed by the task manager.
The caller must have at least reader authority for the escalation template.
estid
- The escalation template ID whose
custom property names are to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
NotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.util.List getCustomPropertyNames(ESIID esiid) throws NotAuthorizedException, IdWrongFormatException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to escalations beyond those provided and managed by the task manager.
Custom properties names can be retrieved in any state of the escalation instance. The caller must have at least reader authority for the escalation instance.
esiid
- The escalation instance ID whose
custom property names are to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
NotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.util.List getCustomPropertyNames(TKTID tktid) throws NotAuthorizedException, IdWrongFormatException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to tasks beyond those provided and managed by the task manager.
The caller must have at least reader authority for the task template.
tktid
- The task template ID whose
custom property names are to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
NotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.util.List getCustomPropertyNames(TKIID tkiid) throws NotAuthorizedException, IdWrongFormatException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to tasks beyond those provided and managed by the task manager.
Custom properties names can be retrieved in any state of the task instance. The caller must have at least reader authority for the task instance.
tkiid
- The task instance ID whose
custom property names are to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
NotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
java.util.List getCustomProperties(TKTID tktid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to a tasks beyond those provided and managed by the task manager.
The caller must have at least reader authority for the task template.
tktid
- The task template ID whose
custom properties are to be retrieved.
CustomProperty
objects.
Returns an empty list when there are no custom properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.util.List getCustomProperties(TKIID tkiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to a task beyond those provided and managed by the task manager.
Custom properties can be retrieved in any state of the task instance. The caller must have at least reader authority for the task instance.
tkiid
- The task instance ID whose
custom properties are to be retrieved.
CustomProperty
objects.
Returns an empty list when there are no custom properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
BinaryCustomProperty getBinaryCustomProperty(java.lang.String identifier, java.lang.String propertyName) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to tasks or escalations beyond those provided and managed by the task manager. Binary custom properties allow, for example, to attach a Java object to a task instance. Binary custom properties cannot be searched for directly. It is, however, possible to specify an additional queryable string.
A binary custom property can be retrieved in any state of a the task or escalation instance. The caller must have at least reader authority for the task instance.
identifier
- A string representation of the task or escalation instance ID. This
string is used to identify the task or escalation instance for which the binary
custom property is to be retrieved.propertyName
- The name of the binary custom property to be retrieved.
BinaryCustomProperty
object.
Returns null when the named binary custom property cannot be found.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
BinaryCustomProperty getBinaryCustomProperty(ESIID esiid, java.lang.String propertyName) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to escalations beyond those provided and managed by the task manager. Binary custom properties allow, for example, to attach a Java object to an escalation instance. Binary custom properties cannot be searched for directly. It is, however, possible to specify an additional queryable string.
A binary custom property can be retrieved in any state of a the escalation instance. The caller must have at least reader authority for the escalation instance.
esiid
- The escalation instance ID. This ID
is used to identify the escalation instance for which the binary
custom property is to be retrieved.propertyName
- The name of the binary custom property to be retrieved.
BinaryCustomProperty
object.
Returns null when the named binary custom property cannot be found.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
BinaryCustomProperty getBinaryCustomProperty(TKIID tkiid, java.lang.String propertyName) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to tasks beyond those provided and managed by the task manager. Binary custom properties allow, for example, to attach a Java object to a task instance. Binary custom properties cannot be searched for directly. It is, however, possible to specify an additional queryable string.
A binary custom property can be retrieved in any state of a the task instance. The caller must have at least reader authority for the task instance.
tkiid
- The task instance ID. This ID
is used to identify the task instance for which the binary
custom property is to be retrieved.propertyName
- The name of the binary custom property to be retrieved.
BinaryCustomProperty
object.
Returns null when the named binary custom property cannot be found.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
java.util.List getBinaryCustomPropertyNames(java.lang.String identifier) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to tasks or escalations beyond those provided and managed by the task manager. Binary custom properties allow, for example, to attach a Java object to a task instance. Binary custom properties cannot be searched for directly. It is, however, possible to specify an additional queryable string.
Binary custom properties names can be retrieved in any state of the task or escalation instance. The caller must have at least reader authority for the task instance.
identifier
- A string representation of the task or escalation instance ID. This
string is used to identify the task or escalation instance for which the binary
custom property names are to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.util.List getBinaryCustomPropertyNames(ESIID esiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to escalations beyond those provided and managed by the task manager. Binary custom properties allow, for example, to attach a Java object to an escalation instance. Binary custom properties cannot be searched for directly. It is, however, possible to specify an additional queryable string.
Binary custom properties names can be retrieved in any state of the escalation instance. The caller must have at least reader authority for the escalation instance.
esiid
- The escalation instance ID. This ID
is used to identify the escalation instance for which the binary
custom property names are to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.util.List getBinaryCustomPropertyNames(TKIID tkiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to tasks beyond those provided and managed by the task manager. Binary custom properties allow, for example, to attach a Java object to a task instance. Binary custom properties cannot be searched for directly. It is, however, possible to specify an additional queryable string.
Binary custom properties names can be retrieved in any state of the task instance. The caller must have at least reader authority for the task instance.
tkiid
- The task instance ID. This ID
is used to identify the task instance for which the binary
custom property names are to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.util.List getCustomProperties(java.lang.String identifier) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to tasks or escalations beyond those provided and managed by the task manager.
Custom properties can be retrieved in any state of a task or escalation instance. The caller must have at least reader authority for the task or escalation.
identifier
- A string representation of the task instance, task template, escalation
instance, or escalation template ID. This
string is used to identify the object for which the
custom properties are to be retrieved.
CustomProperty
objects.
Returns an empty list when there are no custom properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.util.List getCustomProperties(ESTID estid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to an escalation beyond those provided and managed by the task manager.
The caller must have at least reader authority for the escalation template.
estid
- The escalation template ID whose
custom properties are to be retrieved.
CustomProperty
objects.
Returns an empty list when there are no custom properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.util.List getCustomProperties(ESIID esiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to an escalation beyond those provided and managed by the task manager.
Custom properties can be retrieved in any state of the escalation instance. The caller must have at least reader authority for the escalation instance.
esiid
- The escalation instance ID whose
custom properties are to be retrieved.
CustomProperty
objects.
Returns an empty list when there are no custom properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.lang.String getDocumentation(java.lang.String identifier, java.util.Locale locale) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Documentations can be retrieved in any state of the object. The caller must have at least reader authority for the object.
identifier
- A string representation of the object ID that is used
to identify the object.locale
- The locale for which the documentation is to be provided.
If no locale is provided, then the documentation is searched for in the default language.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.lang.String getDocumentation(ESIID esiid, java.util.Locale locale) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Documentations can be retrieved in any state of the escalation. The caller must have at least reader authority for the escalation.
esiid
- The escalation instance ID that is used
to identify the escalation instance.locale
- The locale for which the documentation is to be provided.
If no locale is provided, then the documentation is searched for in the default language.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.lang.String getDocumentation(ESTID estid, java.util.Locale locale) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
The caller must have at least reader authority for the escalation template.
estid
- The escalation template ID that is used
to identify the escalation template.locale
- The locale for which the documentation is to be provided.
If no locale is provided, then the documentation is searched for in the default language.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.lang.String getDocumentation(TKIID tkiid, java.util.Locale locale) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Documentations can be retrieved in any state of the task instance. The caller must have at least reader authority for the task instance.
tkiid
- The task instance ID that is used to identify the task instance.locale
- The locale for which the documentation is to be provided.
If no locale is provided, then the documentation is searched for in the default language.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.lang.String getDocumentation(TKTID tktid, java.util.Locale locale) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
The caller must have at least reader authority for the task template.
tktid
- The task template ID that is used to identify the task template.locale
- The locale for which the documentation is to be provided.
If no locale is provided, then the documentation is searched for in the default language.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Escalation getEscalation(java.lang.String esiid) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Escalations can be retrieved in any escalation state. The caller must have at least reader authority.
esiid
- A string representation of the escalation instance ID that is used
to identify the escalation to be retrieved.
Escalation
to view the escalation properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Escalation getEscalation(ESIID esiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
Escalations can be retrieved in any escalation state. The caller must have at least reader authority.
esiid
- The escalation instance ID that is used
to identify the escalation to be retrieved.
Escalation
to view the escalation properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
EscalationTemplate getEscalationTemplate(java.lang.String estid) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
The caller must have at least reader authority.
estid
- A string representation of the escalation template ID that is used
to identify the escalation template to be retrieved.
EscalationTemplate
to view the escalation template properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
EscalationTemplate getEscalationTemplate(ESTID estid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
The caller must have at least reader authority.
estid
- The escalation template ID that is used
to identify the escalation template to be retrieved.
EscalationTemplate
to view the escalation template properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
ClientObjectWrapper getFaultMessage(java.lang.String tkiid) throws DataHandlingException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be a to-do, collaboration, or invocation task. Collaboration, to-do, and invocation task instances are also known as human, participating, and originating task instances.
The task instance can be in any state but inactive. The caller must have at least reader authority for the task instance.
tkiid
- A string representation of the task instance ID. This string is used to
identify the task instance for which the fault message is to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
DataHandlingException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
ClientObjectWrapper getFaultMessage(TKIID tkiid) throws DataHandlingException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be a to-do, collaboration, or invocation task. Collaboration, to-do, and invocation task instances are also known as human, participating, and originating task instances.
The task instance can be in any state but inactive. The caller must have at least reader authority for the task instance.
tkiid
- The object ID of the task instance for which the fault message is to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
DataHandlingException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
java.util.List getFaultNames(java.lang.String tkiid) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be a to-do, collaboration, or invocation task. Collaboration, to-do, and invocation task instances are also known as human, participating, and originating task instances.
The task instance can be in any state. The caller must have at least reader authority for the task instance.
tkiid
- A string representation of the task instance ID that
is used to identify the task instance for which fault names are to be retrieved.
complete
,
setFaultMessage
,
or to createFaultMessage
.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
java.util.List getFaultNames(TKIID tkiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be a to-do, collaboration, or invocation task. Collaboration, to-do, and invocation task instances are also known as human, participating, and originating task instances.
The task instance can be in any state. The caller must have at least reader authority for the task instance.
tkiid
- The object ID of the task instance for which the fault names are to be retrieved.
complete
,
setFaultMessage
,
or to createFaultMessage
.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
java.util.List getGroupDetails(java.lang.String[] groupNames, java.lang.String[] groupProperties, java.lang.String[] userProperties, java.lang.String[] subGroupProperties, java.lang.Integer threshold) throws ParameterNullException, StaffServiceCannotAccessVMMException, StaffServiceRuntimeException, UnexpectedFailureException, CommunicationException
Note that this request does not participate in any global transaction, that is, exceptions do not cause a global transaction rollback.
groupNames
- The groups that are to be queried. The names are unique names as defined in VMM.groupProperties
- The Group VMM properties that are to be returned
for the specified groups. The "members" property is ignored, if specified.userProperties
- The PersonAccount VMM properties that are to be returned for the users
directly contained in the group. If not specified, an empty list of user details is returned.subGroupProperties
- The Group VMM properties that are to be returned for the subgroups
directly contained in the group. If not specified, an empty list of group details is returned.
Note that the "members" property is ignored, if specified.threshold
- The maximum number of group, user, or subgroup details to be returned from the
server to the client. If a threshold is not to be applied, null must be specified.
Group details are determined depth-first. This means that the last group returned may not be complete if a threshold is applied.
GroupDetail
objects.
An object is returned for each group specified even when the group does not exist.
In that case, the group is marked as not found in the peopele directory.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ParameterNullException
StaffServiceCannotAccessVMMException
StaffServiceRuntimeException
UnexpectedFailureException
java.lang.String[] getGroupNames() throws UserDoesNotExistException, UserRegistryException, UnexpectedFailureException, CommunicationException
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
UserDoesNotExistException
UserRegistryException
UnexpectedFailureException
HtmConfiguration getHtmConfiguration() throws CommunicationException
This interface returns configuration settings that influence the functionality of specific API methods. For example, whether substitution or group work items are enabled.
HtmConfiguration
to view the Human Task Manager
configuration settings returned.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ClientObjectWrapper getInputMessage(java.lang.String tkiid) throws DataHandlingException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The input message can be retrieved in any state of the task instance. The caller must have at least reader authority for the task instance.
tkiid
- A string representation of the task instance ID. The string is used
to identify the task instance for which the input message
is to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
DataHandlingException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
ClientObjectWrapper getInputMessage(TKIID tkiid) throws DataHandlingException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The input message can be retrieved in any state of the task instance. The caller must have at least reader authority for the task instance.
tkiid
- The object ID of the task instance whose input message is to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
DataHandlingException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
java.lang.String getMessageTextOfException(java.util.Locale locale, java.lang.String messageKey, java.lang.Object[] variableValues) throws ParameterNullException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
locale
- The locale to specify the language in which the message text is to be retrieved.
If no locale is specified, the default language of the server is used.messageKey
- The message key of the exception.variableValues
- The values of variables to be pasted into the message text, if any.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ParameterNullException
ObjectDoesNotExistException
UnexpectedFailureException
ClientObjectWrapper getOutputMessage(java.lang.String tkiid) throws DataHandlingException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The output message can be retrieved in any state of the task instance. The caller must have at least reader authority for the task instance.
tkiid
- A string representation of the task instance ID that is used
to identify the task instance for which the output message is to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
DataHandlingException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
ClientObjectWrapper getOutputMessage(TKIID tkiid) throws DataHandlingException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The output message can be retrieved in any state of the task instance. The caller must have at least reader authority for the task instance.
tkiid
- The object ID of the task instance whose output message is to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
DataHandlingException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
StoredQuery getStoredQuery(java.lang.String storedQueryName) throws ObjectDoesNotExistException, ParameterNullException, UnexpectedFailureException, CommunicationException
storedQueryName
- The name of the stored query to be retrieved -
refer to getStoredQueryNames
for the retrieval of existing stored query names.
StoredQuery
to view the stored query definition.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
StoredQuery getStoredQuery(java.lang.String userID, java.lang.String storedQueryName) throws NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, UnexpectedFailureException, CommunicationException
userID
- The name of the user who is the owner of the stored query. If no user is
specified, a public stored query with the specified name is retrieved.storedQueryName
- The name of the stored query to be retrieved -
refer to getStoredQueryNames
for the retrieval of existing stored query names.
StoredQuery
to view the stored query definition.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
StoredQuery getStoredQuery(int kind, java.lang.String storedQueryName) throws InvalidParameterException, ObjectDoesNotExistException, ParameterNullException, UnexpectedFailureException, CommunicationException
kind
- An indicator to specify whether a private or public stored query is to be
retrieved.
KIND_PUBLIC states that a public stored query is to be retrieved. KIND_PRIVATE states that a private stored query for the logged-on user is to be retrieved.
storedQueryName
- The name of the stored query to be retrieved -
refer to getStoredQueryNames
for the retrieval of existing stored query names.
StoredQuery
to view the stored query definition.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
InvalidParameterException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
java.lang.String[] getStoredQueryNames() throws WorkItemManagerException, UnexpectedFailureException, CommunicationException
Refer to createStoredQuery
for the
creation of stored queries.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
WorkItemManagerException
UnexpectedFailureException
java.lang.String[] getStoredQueryNames(java.lang.String userID) throws NotAuthorizedException, UnexpectedFailureException, CommunicationException
Refer to createStoredQuery
for the
creation of stored queries.
userID
- The name of the user who is the owner of the private stored queries whose names are to
be retrieved together with any public names. A regular user can only specify his
own name; a task system administrator can also specify the name of a different user.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
NotAuthorizedException
UnexpectedFailureException
java.lang.String[] getStoredQueryNames(int kind) throws InvalidParameterException, UnexpectedFailureException, CommunicationException
Refer to createStoredQuery
for the
creation of stored queries.
kind
- An indicator to specify whether a private or public stored query names are to be
retrieved.
KIND_PUBLIC states that names of public stored queries are to be retrieved. KIND_PRIVATE states that names of private stored queries for the logged-on user are to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
InvalidParameterException
UnexpectedFailureException
java.util.List getSubTaskIDs(java.lang.String tkiid) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
The caller must have at least reader authority for the task instance.
tkiid
- A string representation of the task instance ID that is used to identify
the task instance for which the subtask IDs are to be retrieved.
TKIID
).
Returns an empty list when there are no subtasks.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.util.List getSubTaskIDs(TKIID tkiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
The caller must have at least reader authority for the task instance.
tkiid
- The task instance ID that is used to identify the task instance
for which the subtask IDs are to be retrieved.
TKIID
).
Returns an empty list when there are no subtasks.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
java.util.List getSubstitutes() throws StaffServiceCannotAccessVMMException, StaffServiceSubstitutionNotEnabledException, StaffServiceRuntimeException, UserDoesNotExistException, UnexpectedFailureException, CommunicationException
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
StaffServiceCannotAccessVMMException
StaffServiceSubstitutionNotEnabledException
StaffServiceRuntimeException
UserDoesNotExistException
UnexpectedFailureException
java.util.List getSubstitutes(java.lang.String userID) throws NotAuthorizedException, ParameterNullException, StaffServiceCannotAccessVMMException, StaffServiceSubstitutionNotEnabledException, StaffServiceRuntimeException, UserDoesNotExistException, UnexpectedFailureException, CommunicationException
If retrieving the substitutes is not restricted to administrators, then everybody can retrieve the substitutes of any user.
If retrieving the substitutes is restricted to administrators, then only task system monitors or task system administrators can retrieve the substitutes of arbitrary users. A user may, however, always read his/her personal settings.
userID
- The name of the user whose substitutes are to be retrieved.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
NotAuthorizedException
ParameterNullException
StaffServiceCannotAccessVMMException
StaffServiceSubstitutionNotEnabledException
StaffServiceRuntimeException
UserDoesNotExistException
UnexpectedFailureException
Task getTask(java.lang.String tkiid) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
The task instance can be in any state. The caller must have at least reader authority for the task instance.
tkiid
- A string representation of the task instance ID. This is used
to identify the task instance to be retrieved.
Task
to view the task instance properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Task getTask(TKIID tkiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
The task instance can be in any state. The caller must have at least reader authority for the task instance.
tkiid
- The object ID of the task instance to be retrieved.
Task
to view the task instance properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
TaskTemplate getTaskTemplate(java.lang.String tktid) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
The caller must have at least reader authority for the task template.
tktid
- A string representation of the object ID of the task template to be retrieved.
TaskTemplate
to view the task template properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
TaskTemplate getTaskTemplate(TKTID tktid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
The caller must have at least reader authority for the task template.
tktid
- The object ID of the task template to be retrieved.
TaskTemplate
to view the task template properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
com.ibm.bpe.api.AIID getActivityID(java.lang.String tkiid) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
The task instance can be in any state. The caller must have at least reader authority for the task instance.
tkiid
- A string representation of the task instance ID. This is used
to identify the task instance.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
com.ibm.bpe.api.AIID getActivityID(TKIID tkiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
The task instance can be in any state. The caller must have at least reader authority for the task instance.
tkiid
- The object ID of the task instance.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
com.ibm.bpe.api.PIID getProcessID(java.lang.String tkiid) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
The task instance can be in any state. The caller must have at least reader authority for the task instance.
tkiid
- A string representation of the task instance ID. This is used
to identify the task instance.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
com.ibm.bpe.api.PIID getProcessID(TKIID tkiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, CommunicationException
The task instance can be in any state. The caller must have at least reader authority for the task instance.
tkiid
- The object ID of the task instance.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
CustomClientSettings getUISettings(java.lang.String identifier) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, UnexpectedFailureException, CommunicationException
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.
Client interface settings can be retrieved in any state of the task instance. The caller must have at least reader authority for the task instance or template.
identifier
- A string representation of the task instance or template ID.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
UnexpectedFailureException
CustomClientSettings getUISettings(TKTID tktid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, WrongKindException, CommunicationException
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.
The caller must have at least reader authority for the task template.
tktid
- The object ID of the task template.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
WrongKindException
CustomClientSettings getUISettings(TKIID tkiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, UnexpectedFailureException, WrongKindException, CommunicationException
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.
Client interface settings can be retrieved in any state of the task instance. The caller must have at least reader authority for the task instance.
tkiid
- The object ID of the task instance.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
WrongKindException
java.util.List getUserDetails(java.lang.String[] userIDs, java.lang.String[] userProperties) throws ParameterNullException, StaffServiceCannotAccessVMMException, StaffServiceRuntimeException, UnexpectedFailureException, CommunicationException
Note that this request does not participate in any global transaction, that is, exceptions do not cause a global transaction rollback.
userIDs
- The users that are to be queried.userProperties
- The PersonAccount VMM properties that are to be returned for the specified users.
If no user properties are specified, then no properties are returned. It is, however,
stated whether the user
is defined in the people directory or whether the user is a virtual user.
UserDetail
objects.
An object is returned for each user specified even when the user does not exist.
In that case, the user is marked as not found in the people directory.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ParameterNullException
StaffServiceCannotAccessVMMException
StaffServiceRuntimeException
UnexpectedFailureException
StaffResultSet getUsersInRole(java.lang.String identifier, int role) throws IdWrongFormatException, IdWrongTypeException, InvalidAssignmentReasonException, NotAuthorizedException, ObjectDoesNotExistException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
identifier
- A string representation of task instance or template ID that is used to identify the
task instance or template.role
- The role whose members are to be queried. Refer to
WorkItem.getAssignmentReason
.
StaffResultSet
for more information.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
InvalidAssignmentReasonException
NotAuthorizedException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
StaffResultSet getUsersInRole(TKTID tktid, int role) throws IdWrongFormatException, InvalidAssignmentReasonException, NotAuthorizedException, ObjectDoesNotExistException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
tktid
- The object ID of the task template that is used to identify the
task template.role
- The role whose members are to be queried, either an administrator,
reader, or potential instance creator. Refer to
WorkItem.getAssignmentReason
.
StaffResultSet
for more information.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
InvalidAssignmentReasonException
NotAuthorizedException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
StaffResultSet getUsersInRole(TKIID tkiid, int role) throws IdWrongFormatException, InvalidAssignmentReasonException, NotAuthorizedException, ObjectDoesNotExistException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
tkiid
- The object ID of the task instance that is used to identify the
task instance.role
- The role whose members are to be queried, either an administrator,
reader, editor, potential owner, owner, potential starter, starter, originator,
or escalation receiver. Refer to
WorkItem.getAssignmentReason
.
StaffResultSet
for more information.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
InvalidAssignmentReasonException
NotAuthorizedException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
WorkItem[] getWorkItems(java.lang.String identifier) throws IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
The task or escalation instance can be in any execution state.
Note that a task system administrator is treated like any other user, that is, does only see the personally owned work items.
identifier
- The string representation of a task or escalation instance ID. The string is
used to identify the object whose work item assignments are to be retrieved.
WorkItem
to view the work item properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
WorkItem[] getWorkItems(ESIID esiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
The escalation instance can be in any state.
Note that a task system administrator is treated like any other user, that is, does only see the personally owned work items.
esiid
- The object ID of the escalation instance. This ID is used to identify
the escalation whose work item assignments are to be retrieved.
WorkItem
to view the work item properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
WorkItem[] getWorkItems(TKIID tkiid) throws IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
The task instance can be in any execution state.
Note that a task system administrator is treated like any other user, that is, does only see the personally owned work items.
tkiid
- The object ID of the task instance. This ID is used to identify
the task whose work item assignments are to be retrieved.
WorkItem
to view the work item properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
boolean isSystemAdministrator() throws CommunicationException
In general, authorization is granted to persons explicitly when a task template is defined or implicitly, for example, when a task is started. Above that, special authority is granted to a person playing the role of a task system administrator. A system administrator has all priviledges.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
boolean isSystemMonitor() throws CommunicationException
In general, authorization is granted to persons explicitly when a task template is defined or implicitly, for example, when a task is started. Above that, special authority is granted to a person playing the role of a task system monitor. A task system monitor has the priviledge to read all objects.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
boolean isUserInRole(java.lang.String identifier, java.lang.String userID, int role) throws IdWrongFormatException, IdWrongTypeException, InvalidAssignmentReasonException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, UserRegistryException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
identifier
- A string representation of task instance or template ID that is used to identify the
task instance or template.userID
- The user whose membership in a role is to be queried.
The existence of the user ID is verified but the verification may be executed case insensitively. Verification can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments' custom property of the Human Task Manager configuration to 'true'.
role
- The role that the user needs to be a member of.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
InvalidAssignmentReasonException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
UserRegistryException
WorkItemManagerException
UnexpectedFailureException
boolean isUserInRole(TKTID tktid, java.lang.String userID, int role) throws IdWrongFormatException, InvalidAssignmentReasonException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, UserRegistryException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
tktid
- The object ID of the task template that is used to identify the
task template.userID
- The user whose membership in a role is to be queried.
The existence of the user ID is verified but the verification may be executed case insensitively. Verification can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments' custom property of the Human Task Manager configuration to 'true'.
role
- The role that the user needs to be a member of, either an administrator,
reader, or potential instance creator.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
InvalidAssignmentReasonException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
UserRegistryException
WorkItemManagerException
UnexpectedFailureException
boolean isUserInRole(TKIID tkiid, java.lang.String userID, int role) throws IdWrongFormatException, InvalidAssignmentReasonException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, UserRegistryException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
tkiid
- The object ID of the task instance that is used to identify the
task instance.userID
- The user whose membership in a role is to be queried.
The existence of the user ID is verified but the verification may be executed case insensitively. Verification can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments' custom property of the Human Task Manager configuration to 'true'.
role
- The role that the user needs to be a member of, either an administrator,
reader, editor, potential owner, owner, potential starter, starter, originator,
or escalation receiver.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
InvalidAssignmentReasonException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
UserRegistryException
WorkItemManagerException
UnexpectedFailureException
QueryResultSet query(java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer threshold, java.util.TimeZone timeZone) throws ParameterNullException, UnexpectedFailureException, WorkItemManagerException, CommunicationException
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. Sorting on the server means that the locale of the server is used.
Specify the parameters of the query, the select-, where-, and order-by-clause, using SQL based on the published views. Execution of the query can thus be shifted to SQL and becomes portable and optimizable.
Note, however, when you use a combination of the order-by-clause and threshold parameters, the tuples returned depend on your database system. For example, some database systems order all records and then return the requested number of tuples. Other database systems first take the requested number of tuples and then apply the order criteria.
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 or which can be transitively reached via your work item. As a rule of thumb, all objects except task templates can be reached via work items. This means that you cannot use task template properties only but that you must specify a non task template property in the select- or where-clause.
Note that a task system administrator has special rights and can retrieve information on objects associated to other users. query() thus returns the selected properties of all objects for which there are work items to the task systems administrator, no matter whether there is a personally owned work item or another user's work item. If the task system administrator wants to view everything that is stored on the database, independently from the existence of a work item, he/she can use queryAll().
selectClause
- Describes the query result, that is, declares a list of names
that identify the object properties (columns of the result) to be returned.
Its syntax is an SQL select-clause. Aggregation functions like AVG(), SUM(),
MIN(), and MAX() are not supported.
Each comma separated part of the select-clause must specify a property from the
published views - see the InfoCenter for details.
To select properties of name-value pairs like custom properties, add a one-digit suffix (0-9) to the view name. For example, "TASK_CPROP1.STRING_VALUE, TASK_CPROP2.STRING_VALUE".
To count the number of potentially qualifying tuples, use the COUNT keyword. For example, to count the number of task instance IDs that satisfy the where-clause, specify a select-clause such as "COUNT(DISTINCT TASK.TKIID)". If you use the more generic "COUNT(*)", then you must specify a where-clause so that the tuples to be counted can be determined. For example, to count all tasks, specify a where-clause such as "TASK.TKIID=TASK.TKIID" that always evaluates to true.
The QueryResultSet contains columns in the same order as specified in the selectClause. If tuples are to be counted, an int value is returned (row 1, column 1).
whereClause
- The search condition to be applied to the query domain.
Its syntax is an SQL where-clause. The following rules apply:
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 views - see the InfoCenter for details.
If you identify more that one property, the query result set is ordered by the values of the first property you identify, then by the values of the second property, and so on.
If sort criteria are not to be applied, null must be specified.
Note that sort criteria are applied on the server, that is, the locale of the server is used for sorting.
threshold
- The maximum number of query result set tuples to be returned from the
server to the client. If a threshold is not to be applied, null must be specified.timeZone
- The time zone of the timestamp constants in the whereClause
respectively the time zone for the timestamp values returned.
If a timezone is not specified, UTC is assumed.
QueryResultSet
for information on how to analyze the query result set.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ParameterNullException
UnexpectedFailureException
WorkItemManagerException
QueryResultSet query(java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer skipTuples, java.lang.Integer threshold, java.util.TimeZone timeZone) throws ParameterNullException, UnexpectedFailureException, WorkItemManagerException, CommunicationException
You can specify a filter, a starting tuple, or a threshold to restrict the number of tuples returned. The tuples are sorted on the server according to the specified sort criteria. Sorting on the server means that the locale of the server is used.
Specify the parameters of the query, the select-, where-, and order-by-clause, using SQL based on the published views. Execution of the query can thus be shifted to SQL and becomes portable and optimizable.
Note, however, when you use a combination of the order-by-clause, threshold, or skipTuples parameters, the tuples returned depend on your database system. For example, some database systems order all records and then return the requested number of tuples. Other database systems first take the requested number of tuples and then apply the order criteria.
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, or which can be transitively reached via your work item. As a rule of thumb, all objects except task templates can be reached via work items. This means that you cannot use task template properties only but that you must specify a non task template property in the select- or where-clause.
Note that a task system administrator has special rights and can retrieve information on objects associated to other users. query() thus returns the selected properties of all objects for which there are work items to the task systems administrator, no matter whether there is a personally owned work item or another user's work item. If the task system administrator wants to view everything that is stored on the database, independently from the existence of a work item, he/she can use queryAll().
selectClause
- Describes the query result, that is, declares a list of names
that identify the object properties (columns of the result) to be returned.
Its syntax is an SQL select-clause. Aggregation functions like AVG(), SUM(),
MIN(), and MAX() are not supported.
Each comma separated part of the select-clause must specify a property from the
published views - see the InfoCenter for details.
To select properties of name-value pairs like custom properties, add a one-digit suffix (0-9) to the view name. For example, "TASK_CPROP1.STRING_VALUE, TASK_CPROP2.STRING_VALUE".
To count the number of potentially qualifying tuples, use the COUNT keyword. For example, to count the number of task instance IDs that satisfy the where-clause, specify a select-clause such as "COUNT(DISTINCT TASK.TKIID)". If you use the more generic "COUNT(*)", then you must specify a where-clause so that the tuples to be counted can be determined. For example, to count all tasks, specify a where-clause such as "TASK.TKIID=TASK.TKIID" that always evaluates to true.
The QueryResultSet contains columns in the same order as specified in the selectClause. If tuples are to be counted, an int value is returned (row 1, column 1).
whereClause
- The search condition to be applied to the query domain.
Its syntax is an SQL where-clause. The following rules apply:
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 views - see the InfoCenter for details.
If you identify more that one property, the query result set is ordered by the values of the first property you identify, then by the values of the second property, and so on.
If sort criteria are not to be applied, null must be specified.
Note that sort criteria are applied on the server, that is, the locale of the server is used for sorting.
skipTuples
- The number of query result set tuples to be ignored and not to be
returned to the caller. For example, a value of '5' means that the first 5
qualifying tuples are not returned. Use this parameter together with the threshold
to implement paging in your client application.
If all qualifying tuples are to be returned, null or 0 must be specified.
threshold
- The maximum number of query result set tuples to be returned from the server to the client.
If a threshold is not to be applied, null must be specified.timeZone
- The time zone of the timestamp constants in the whereClause
respectively the time zone for the timestamp values returned.
If a timezone is not specified, UTC is assumed.
QueryResultSet
for information on how to analyze the query result set.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ParameterNullException
UnexpectedFailureException
WorkItemManagerException
QueryResultSet query(java.lang.String storedQueryName, java.lang.Integer skipTuples) throws IdWrongFormatException, ObjectDoesNotExistException, ParameterNullException, QueryCannotJoinException, QueryInvalidOperandException, QueryInvalidTimestampException, QueryUndefinedParameterException, QueryUnknownColumnException, QueryUnknownOperatorException, QueryUnknownTableException, UnexpectedFailureException, CommunicationException
query(Sting storedQueryName, Integer skipTuples, List parameters)
,
Only properties of objects are returned for which the logged-on user has a work item. Note that a task system administrator has special rights and can retrieve information on objects associated to other users. query() thus returns the selected properties of all objects for which there are work items to the task systems administrator, no matter whether there is a personally owned work item or another user's work item.
Refer to createStoredQuery
for
the creation of stored queries.
storedQueryName
- The name of the stored query to be executed -
refer to getStoredQueryNames
for the retrieval of existing stored query names.skipTuples
- The number of query result set tuples to be ignored and not to be
returned to the caller. For example, a value of '5' means that the first 5
qualifying tuples are not returned. Use this parameter together with the threshold
of the stored query definition to implement paging in your client application.
If all qualifying tuples are to be returned, null or 0 must be specified.
QueryResultSet
for information on how to analyze the query result set.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
ObjectDoesNotExistException
ParameterNullException
QueryCannotJoinException
QueryInvalidOperandException
QueryInvalidTimestampException
QueryUndefinedParameterException
QueryUnknownColumnException
QueryUnknownOperatorException
QueryUnknownTableException
UnexpectedFailureException
QueryResultSet query(java.lang.String storedQueryName, java.lang.Integer skipTuples, java.util.List parameters) throws IdWrongFormatException, InvalidStoredQueryParametersException, ObjectDoesNotExistException, ParameterNullException, QueryCannotJoinException, QueryInvalidOperandException, QueryInvalidTimestampException, QueryUndefinedParameterException, QueryUnknownColumnException, QueryUnknownOperatorException, QueryUnknownTableException, UnexpectedFailureException, CommunicationException
Only properties of objects are returned for which the logged-on user has a work item. Note that a task system administrator has special rights and can retrieve information on objects associated to other users. query() thus returns the selected properties of all objects for which there are work items to the task systems administrator, no matter whether there is a personally owned work item or another user's work item.
Refer to createStoredQuery
for
the creation of stored queries.
storedQueryName
- The name of the stored query to be executed -
refer to getStoredQueryNames
for the retrieval of existing stored query names.skipTuples
- The number of query result set tuples to be ignored and not to be
returned to the caller. For example, a value of '5' means that the first 5
qualifying tuples are not returned. Use this parameter together with the threshold
of the stored query definition to implement paging in your client application.
If all qualifying tuples are to be returned, null or 0 must be specified.
parameters
- A list of string values to replace parameters in the where-clause. There must
be a value for each parameter in the where-clause. The first string replaces all occurrences of @param1,
the second string replaces all occurrences of @param2, and so on.
QueryResultSet
for information on how to analyze the query result set.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
InvalidStoredQueryParametersException
ObjectDoesNotExistException
ParameterNullException
QueryCannotJoinException
QueryInvalidOperandException
QueryInvalidTimestampException
QueryUndefinedParameterException
QueryUnknownColumnException
QueryUnknownOperatorException
QueryUnknownTableException
UnexpectedFailureException
QueryResultSet query(java.lang.String storedQueryName, java.lang.Integer skipTuples, java.lang.Integer threshold) throws IdWrongFormatException, ObjectDoesNotExistException, ParameterNullException, QueryCannotJoinException, QueryInvalidOperandException, QueryInvalidTimestampException, QueryUndefinedParameterException, QueryUnknownColumnException, QueryUnknownOperatorException, QueryUnknownTableException, UnexpectedFailureException, CommunicationException
query(Sting storedQueryName, Integer skipTuples, Integer threshold, List parameters)
,
Only properties of objects are returned for which the logged-on user has a work item. Note that a task system administrator has special rights and can retrieve information on objects associated to other users. query() thus returns the selected properties of all objects for which there are work items to the task systems administrator, no matter whether there is a personally owned work item or another user's work item.
Refer to createStoredQuery
for
the creation of stored queries.
storedQueryName
- The name of the stored query to be executed -
refer to getStoredQueryNames
for the retrieval of existing stored query names.skipTuples
- The number of query result set tuples to be ignored and not to be
returned to the caller. For example, a value of '5' means that the first 5
qualifying tuples are not returned. Use this parameter together with the threshold
to implement paging in your client application.
If all qualifying tuples are to be returned, null or 0 must be specified.
threshold
- The maximum number of result set tuples to be returned from the
server to the client.
If the threshold is to be taken from the stored query definition, specify null or use the
query
method
that does not request a threshold parameter.
QueryResultSet
for information on how to analyze the query result set.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
ObjectDoesNotExistException
ParameterNullException
QueryCannotJoinException
QueryInvalidOperandException
QueryInvalidTimestampException
QueryUndefinedParameterException
QueryUnknownColumnException
QueryUnknownOperatorException
QueryUnknownTableException
UnexpectedFailureException
QueryResultSet query(java.lang.String storedQueryName, java.lang.Integer skipTuples, java.lang.Integer threshold, java.util.List parameters) throws IdWrongFormatException, InvalidStoredQueryParametersException, ObjectDoesNotExistException, ParameterNullException, QueryCannotJoinException, QueryInvalidOperandException, QueryInvalidTimestampException, QueryUndefinedParameterException, QueryUnknownColumnException, QueryUnknownOperatorException, QueryUnknownTableException, UnexpectedFailureException, CommunicationException
If a private stored query with the specified name exists for the calling user, then the private stored query is performed; otherwise the public stored query with the specified name.
Only properties of objects are returned for which the logged-on user has a work item. Note that a task system administrator has special rights and can retrieve information on objects associated to other users. query() thus returns the selected properties of all objects for which there are work items to the task systems administrator, no matter whether there is a personally owned work item or another user's work item.
Refer to createStoredQuery
for
the creation of stored queries.
storedQueryName
- The name of the stored query to be executed -
refer to getStoredQueryNames
for the retrieval of existing stored query names.skipTuples
- The number of query result set tuples to be ignored and not to be
returned to the caller. For example, a value of '5' means that the first 5
qualifying tuples are not returned. Use this parameter together with the threshold
to implement paging in your client application.
If all qualifying tuples are to be returned, null or 0 must be specified.
threshold
- The maximum number of result set tuples to be returned from the
server to the client.
If the threshold is to be taken from the stored query definition, specify null or use the
query
method
that does not request a threshold parameter.parameters
- A list of string values to replace parameters in the where-clause. There must
be a value for each parameter in the where-clause. The first string replaces all occurrences of @param1,
the second string replaces all occurrences of @param2, and so on.
QueryResultSet
for information on how to analyze the query result set.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
InvalidStoredQueryParametersException
ObjectDoesNotExistException
ParameterNullException
QueryCannotJoinException
QueryInvalidOperandException
QueryInvalidTimestampException
QueryUndefinedParameterException
QueryUnknownColumnException
QueryUnknownOperatorException
QueryUnknownTableException
UnexpectedFailureException
QueryResultSet query(java.lang.String userID, java.lang.String storedQueryName, java.lang.Integer skipTuples, java.lang.Integer threshold, java.util.List parameters) throws IdWrongFormatException, InvalidStoredQueryParametersException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, QueryCannotJoinException, QueryInvalidOperandException, QueryInvalidTimestampException, QueryUndefinedParameterException, QueryUnknownColumnException, QueryUnknownOperatorException, QueryUnknownTableException, UnexpectedFailureException, CommunicationException
Only properties of objects are returned for which the logged-on user has a work item. Note that a task system administrator has special rights and can retrieve information on objects associated to other users. query() thus returns the selected properties of all objects for which there are work items to the task systems administrator, no matter whether there is a personally owned work item or another user's work item.
Refer to createStoredQuery
for
the creation of stored queries.
userID
- The name of the user who is the owner of the stored query.storedQueryName
- The name of the stored query to be executed -
refer to getStoredQueryNames
for the retrieval of existing stored query names.skipTuples
- The number of query result set tuples to be ignored and not to be
returned to the caller. For example, a value of '5' means that the first 5
qualifying tuples are not returned. Use this parameter together with the threshold
to implement paging in your client application.
If all qualifying tuples are to be returned, null or 0 must be specified.
threshold
- The maximum number of result set tuples to be returned from the
server to the client.
If the threshold is to be taken from the stored query definition, specify null or use the
query
method
that does not request a threshold parameter.parameters
- A list of string values to replace parameters in the where-clause. There must
be a value for each parameter in the where-clause. The first string replaces all occurrences of @param1,
the second string replaces all occurrences of @param2, and so on.
QueryResultSet
for information on how to analyze the query result set.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
InvalidStoredQueryParametersException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
QueryCannotJoinException
QueryInvalidOperandException
QueryInvalidTimestampException
QueryUndefinedParameterException
QueryUnknownColumnException
QueryUnknownOperatorException
QueryUnknownTableException
UnexpectedFailureException
QueryResultSet query(int kind, java.lang.String storedQueryName, java.lang.Integer skipTuples, java.lang.Integer threshold, java.util.List parameters) throws IdWrongFormatException, InvalidParameterException, InvalidStoredQueryParametersException, ObjectDoesNotExistException, ParameterNullException, QueryCannotJoinException, QueryInvalidOperandException, QueryInvalidTimestampException, QueryUndefinedParameterException, QueryUnknownColumnException, QueryUnknownOperatorException, QueryUnknownTableException, UnexpectedFailureException, CommunicationException
Only properties of objects are returned for which the logged-on user has a work item. Note that a task system administrator has special rights and can retrieve information on objects associated to other users. query() thus returns the selected properties of all objects for which there are work items to the task systems administrator, no matter whether there is a personally owned work item or another user's work item.
Refer to createStoredQuery
for
the creation of stored queries.
kind
- An indicator to specify whether a private or public stored query is to be used.
KIND_PUBLIC states that a public stored query is to be used. KIND_PRIVATE states that a private stored query for the logged-on user is to be used.
storedQueryName
- The name of the stored query to be executed -
refer to getStoredQueryNames
for the retrieval of existing stored query names.skipTuples
- The number of query result set tuples to be ignored and not to be
returned to the caller. For example, a value of '5' means that the first 5
qualifying tuples are not returned. Use this parameter together with the threshold
to implement paging in your client application.
If all qualifying tuples are to be returned, null or 0 must be specified.
threshold
- The maximum number of result set tuples to be returned from the
server to the client.
If the threshold is to be taken from the stored query definition, specify null or use the
query
method
that does not request a threshold parameter.parameters
- A list of string values to replace parameters in the where-clause. There must
be a value for each parameter in the where-clause. The first string replaces all occurrences of @param1,
the second string replaces all occurrences of @param2, and so on.
QueryResultSet
for information on how to analyze the query result set.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
InvalidParameterException
InvalidStoredQueryParametersException
ObjectDoesNotExistException
ParameterNullException
QueryCannotJoinException
QueryInvalidOperandException
QueryInvalidTimestampException
QueryUndefinedParameterException
QueryUnknownColumnException
QueryUnknownOperatorException
QueryUnknownTableException
UnexpectedFailureException
QueryResultSet queryAll(java.lang.String selectClause, java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer skipTuples, java.lang.Integer threshold, java.util.TimeZone timeZone) throws NotAuthorizedException, ParameterNullException, UnexpectedFailureException, WorkItemManagerException, CommunicationException
You can specify a filter, a starting tuple, or a threshold to restrict the number of tuples returned. The tuples are sorted on the server according to the specified sort criteria. Sorting on the server means that the locale of the server is used.
Specify the parameters of the query, the select-, where-, and order-by-clause, using SQL based on the published views. Execution of the query can thus be shifted to SQL and becomes portable and optimizable.
Note, however, when you use a combination of the order-by-clause, threshold, or skipTuples parameters, the tuples returned depend on your database system. For example, some database systems order all records and then return the requested number of tuples. Other database systems first take the requested number of tuples and then apply the order criteria.
The domain of the query, that is, the SQL from-clause, is determined automatically.
The caller must be a task system administrator or monitor.
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(),
MIN(), and MAX() are not supported.
Each comma separated part of the select-clause must specify a property from the
published views - see the InfoCenter for details.
To select properties of name-value pairs like custom properties, add a one-digit suffix (0-9) to the view name. For example, "TASK_CPROP1.STRING_VALUE, TASK_CPROP2.STRING_VALUE".
To count the number of potentially qualifying tuples, use the COUNT keyword. For example, to count the number of task instance IDs that satisfy the where-clause, specify a select-clause such as "COUNT(DISTINCT TASK.TKIID)". If you use the more generic "COUNT(*)", then you must specify a where-clause so that the tuples to be counted can be determined. For example, to count all tasks, specify a where-clause such as "TASK.TKIID=TASK.TKIID" that always evaluates to true.
The QueryResultSet contains columns in the same order as specified in the selectClause. If tuples are to be counted, an int value is returned (row 1, column 1).
whereClause
- The search condition to be applied to the query domain.
Its syntax is an SQL where-clause. The following rules apply:
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 views - see the InfoCenter for details.
If you identify more that one property, the query result set is ordered by the values of the first property you identify, then by the values of the second property, and so on.
If sort criteria are not to be applied, null must be specified.
Note that sort criteria are applied on the server, that is, the locale of the server is used for sorting.
skipTuples
- The number of query result set tuples to be ignored and not to be
returned to the caller. For example, a value of '5' means that the first 5
qualifying tuples are not returned. Use this parameter together with the threshold
to implement paging in your client application.
If all qualifying tuples are to be returned, null or 0 must be specified.
threshold
- The maximum number of query result set tuples to be returned.
If a threshold is not to be applied, null must be specified.timeZone
- The time zone of the timestamp constants in the whereClause
respectively the time zone for the timestamp values returned.
If a timezone is not specified, UTC is assumed.
QueryResultSet
for information on how to analyze the query result set.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
NotAuthorizedException
ParameterNullException
UnexpectedFailureException
WorkItemManagerException
TaskTemplate[] queryTaskTemplates(java.lang.String whereClause, java.lang.String orderByClause, java.lang.Integer threshold, java.util.TimeZone timeZone) throws IdWrongFormatException, QueryCannotJoinException, QueryInvalidOperandException, QueryInvalidTimestampException, QueryUndefinedParameterException, QueryUnknownColumnException, QueryUnknownOperatorException, QueryUnknownTableException, UnexpectedFailureException, CommunicationException
You can specify a threshold or filter to restrict the number of task templates returned. If the number of task templates is not restricted, all task templates that qualify are returned. Note that all versions of a task template are returned unless you filter for their valid-from times. The task templates are sorted on the server according to the specified sort criteria. Sorting on the server means that the locale of the server is used.
The parameters of the query, the where- and order-by-clause, are specified using SQL based on the TASK_TEMPLATE view. Execution of the query can thus be shifted to SQL and becomes portable and customizable.
Note, however, when you use a combination of the order-by-clause and threshold parameters, the tuples returned depend on your database system. For example, some database systems order all records and then return the requested number of tuples. Other database systems first take the requested number of tuples and then apply the order criteria.
whereClause
- The search condition to be applied to the set of available task templates.
Its syntax is an SQL where-clause. The following rules apply:
If a filter is not to be applied, null must be specified.
orderByClause
- Sorts the qualifying task templates 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 TASK_TEMPL view - see the InfoCenter for details.
If you identify more that one property, the task templates are ordered by the values of the first property you identify, then by the values of the second property, and so on.
If sort criteria are not to be applied, null must be specified.
Note that sort criteria are applied on the server, that is, the locale of the server is used for sorting.
threshold
- The maximum number of task 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
respectively the time zone for the timestamp values returned.
If a timezone is not specified, UTC is assumed.
TaskTemplate
to view the task template properties.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
QueryCannotJoinException
QueryInvalidOperandException
QueryInvalidTimestampException
QueryUndefinedParameterException
QueryUnknownColumnException
QueryUnknownOperatorException
QueryUnknownTableException
UnexpectedFailureException
StaffResultSet resolveStaffQuery(java.lang.String parameterizedPeopleAssignmentCriteria, java.lang.String jndiNameOfStaffPluginProvider, int substitutionPolicy, java.util.Map contextVariables) throws InvalidParameterException, ParameterNullException, StaffServiceRuntimeException, UnexpectedFailureException, CommunicationException
Note that any exception thrown does not cause a database rollback because a database update is not involved in this call.
parameterizedPeopleAssignmentCriteria
- The parameterized people assignment criteria to be resolved.
These are the criteria as specified in the TEL.jndiNameOfStaffPluginProvider
- The JNDI name of the people directory configuration to be used.substitutionPolicy
- The substitution policy to be applied. Refer to
SubstitutionPolicy
for valid specifications. Note that
a substitution policy can only be applied if the Virtual Memory Management (VMM)
people directory configuration is used.contextVariables
- An optional map of context variable names and their values.
Context variables allow for context-sensitive queries so that even static people assignment queries
show dynamic behavior. Context variable names are, for example,
wf:process.starter or wf:process.administrators.
The value of a context variable is a string or an array of strings. Note that there can only be a single array with more than one value.
StaffResultSet
for more information.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
InvalidParameterException
ParameterNullException
StaffServiceRuntimeException
UnexpectedFailureException
void restart(java.lang.String tkiid, ClientObjectWrapper input, boolean keepResultMessages) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, IdWrongFormatException, IdWrongTypeException, InvalidApplicationStateException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, SCAServiceAccessFailureException, SCAServiceResultErrorException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance can be a collaboration, invocation, or to-do task. The task instance can be in any state but inactive. Additionally,
The task instance can be escalated, suspended, or waiting for subtasks. The caller must be the starter, originator, or an administrator of the task instance.
Note that collaboration, invocation, and to-do tasks are also known as human, originating, and participating tasks.
Restarting the task instance causes staff resolution to be newly performed and all timers to be reset. Any subtasks or follow-on tasks are deleted. Any escalations are cancelled and reset into the inactive state. For invocation tasks, the logged-on user becomes the starter of the restarted task instance.
tkiid
- A string representation of the task instance ID that is used
to identify the task instance.input
- The input message. If no input message is provided, the original
input message is used.
The object wrapped by the ClientObjectWrapper must be serializable.keepResultMessages
- Specifies whether output or fault messages are to be kept.
True states that any output or fault message set is to be kept.
False states that any output or fault message set is to be deleted.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
IdWrongTypeException
InvalidApplicationStateException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
SCAServiceAccessFailureException
SCAServiceResultErrorException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void restart(TKIID tkiid, ClientObjectWrapper input, boolean keepResultMessages) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, IdWrongFormatException, InvalidApplicationStateException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, SCAServiceAccessFailureException, SCAServiceResultErrorException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance can be a collaboration, invocation, or to-do task. The task instance can be in any state but inactive. Additionally,
The task instance can be escalated, suspended, or waiting for subtasks. The caller must be the starter, originator, or an administrator of the task instance.
Note that collaboration, invocation, and to-do tasks are also known as human, originating, and participating tasks.
Restarting the task instance causes staff resolution to be newly performed and all timers to be reset. Any subtasks or follow-on tasks are deleted. Any escalations are cancelled and reset into the inactive state. For invocation tasks, the logged-on user becomes the starter of the restarted task instance.
tkiid
- The task instance ID that is used to identify the task instance.input
- The input message. If no input message is provided, the original
input message is used.
The object wrapped by the ClientObjectWrapper must be serializable.keepResultMessages
- Specifies whether output or fault messages are to be kept.
True states that any output or fault message set is to be kept.
False states that any output or fault message set is to be deleted.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
InvalidApplicationStateException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
SCAServiceAccessFailureException
SCAServiceResultErrorException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void resume(java.lang.String tkiid) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The suspended task instance can be in the ready or claimed state. It can be escalated or waiting for subtasks. The caller can be the owner, originator, or administrator of the task instance.
tkiid
- A string representation of the task instance ID to be resumed.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void resume(TKIID tkiid) throws ApplicationVetoException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The suspended task instance can be in the ready or claimed state. It can be escalated or waiting for subtasks. The caller can be the owner, originator, or administrator of the task instance.
tkiid
- The object ID of the task instance to be resumed.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
java.util.List searchGroupDetails(java.lang.String searchCondition, java.lang.String[] groupProperties, java.lang.String[] userProperties, java.lang.String[] subGroupProperties, java.lang.Integer threshold) throws ParameterNullException, StaffServiceCannotAccessVMMException, StaffServiceRuntimeException, UnexpectedFailureException, CommunicationException
Note that this request does not participate in any global transaction, that is, exceptions do not cause a global transaction rollback.
searchCondition
- The groups that are to be searched for.
The group names are specified as part of a VMM search expression "//entities[@xsi:type='Group' and ( searchCondition )]". For example, If you specify a search condition "cn='a*'", the following VMM search expression is build and executed: "//entities[@xsi:type='Group' and (cn='a*')]".
groupProperties
- The Group VMM properties that are to be returned
for the groups found. The "members" property is ignored, if specified.
If no group properties are specified, then no properties are returned. The name of the
group is, however, returned.userProperties
- The PersonAccount VMM properties that are to be returned for the users
directly contained in the group. If not specified, an empty list of user details is returned.subGroupProperties
- The Group VMM properties that are to be returned for the subgroups
directly contained in the group. If not specified, an empty list of group details is returned.
Note that the "members" property is ignored, if specified.threshold
- The maximum number of group, user, and subgroup objects to be returned from the
server to the client. If a threshold is not to be applied, null must be specified.
Group details are determined depth-first. This means that the last group returned may not be complete if a threshold is applied.
GroupDetail
objects.
Returns an empty list when there are no groups that fulfil the search condition.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ParameterNullException
StaffServiceCannotAccessVMMException
StaffServiceRuntimeException
UnexpectedFailureException
java.util.List searchUserDetails(java.lang.String searchCondition, java.lang.String[] userProperties, java.lang.Integer threshold) throws ParameterNullException, StaffServiceCannotAccessVMMException, StaffServiceRuntimeException, UnexpectedFailureException, CommunicationException
Note that this request does not participate in any global transaction, that is, exceptions do not cause a global transaction rollback.
searchCondition
- The users that are to be searched for.
The users are specified as part of a VMM search expression "//entities[@xsi:type='PersonAccount' and ( searchCondition )]". For example, If you specify a search condition "uid='a*'", the following VMM search expression is build and executed: "//entities[@xsi:type='PersonAccount' and (uid='a*')]".
userProperties
- The PersonAccount VMM properties that are to be returned for the users found.
If no user properties are specified, then no properties are returned. The name of the
user is, however, returned.threshold
- The maximum number of UserDetail
objects to be returned from the
server to the client. If a threshold is not to be applied, null must be specified.
UserDetail
objects.
Returns an empty list when there are no users that fulfil the search condition.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ParameterNullException
StaffServiceCannotAccessVMMException
StaffServiceRuntimeException
UnexpectedFailureException
void setAbsence(boolean absence) throws StaffServiceCannotAccessVMMException, StaffServiceSubstitutionNotEnabledException, StaffServiceRuntimeException, UserDoesNotExistException, UnexpectedFailureException, CommunicationException
absence
- Specifies the absence setting of the logged-on user.
True states that the specified user is absent.
False states that the specified user is not absent.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
StaffServiceCannotAccessVMMException
StaffServiceSubstitutionNotEnabledException
StaffServiceRuntimeException
UserDoesNotExistException
UnexpectedFailureException
void setAbsence(java.lang.String userID, boolean absence) throws NotAuthorizedException, ParameterNullException, StaffServiceCannotAccessVMMException, StaffServiceSubstitutionNotEnabledException, StaffServiceRuntimeException, UserDoesNotExistException, UnexpectedFailureException, CommunicationException
If setting the absence is not restricted to administrators, then everybody can set the absence flag of any user.
If setting the absence is restricted to administrators, then only the task system administrators can set the absence flag of arbitrary users. A user may, however, always set his/her absence.
userID
- The name of the user whose absence setting is to be set.absence
- States the absence setting of the specified user.
True states that the specified user is absent.
False states that the specified user is not absent.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
NotAuthorizedException
ParameterNullException
StaffServiceCannotAccessVMMException
StaffServiceSubstitutionNotEnabledException
StaffServiceRuntimeException
UserDoesNotExistException
UnexpectedFailureException
void setCustomProperty(java.lang.String identifier, java.lang.String propertyName, java.lang.String propertyValue) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to tasks or escalations beyond those provided and managed by the task manager.
A custom property has a name and a value of type string.
Custom properties can be provided in any state of the task or escalation instance. The parent application may, however, reject to set a property. The caller must be the owner, starter, editor, or administrator of the task instance or must be the escalation receiver or administrator of the escalation instance.
identifier
- A string representation of the task or escalation instance ID
that is used to identify the task or escalation 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.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
UnexpectedFailureException
void setCustomProperty(ESIID esiid, java.lang.String propertyName, java.lang.String propertyValue) throws ApplicationVetoException, IdWrongFormatException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to escalations beyond those provided and managed by the task manager.
A custom property has a name and a value of type string.
Custom properties can be provided in any state of the escalation instance. The parent application may, however, reject to set a property. The caller must be the escalation receiver, or administrator of the escalation instance.
esiid
- The object ID of the escalation 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.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
UnexpectedFailureException
void setCustomProperty(TKIID tkiid, java.lang.String propertyName, java.lang.String propertyValue) throws ApplicationVetoException, IdWrongFormatException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to tasks beyond those provided and managed by the task manager.
A custom property has a name and a value of type string.
Custom properties can be provided in any state of the task instance. The parent application may, however, reject to set a property. The caller must be the owner, starter, editor, or administrator of the task instance.
tkiid
- The object ID of the task 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.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
UnexpectedFailureException
void setBinaryCustomProperty(java.lang.String identifier, BinaryCustomProperty property) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to tasks or escalations beyond those provided and managed by the task manager. Binary custom properties allow, for example, to attach a Java object to a task instance. Binary custom properties cannot be searched for directly. It is, however, possible to specify an additional queryable string.
Custom properties can be provided in any state of the task or escalation instance. The parent application may, however, reject to set a property. The caller must be the owner, starter, editor, or administrator of the task instance or must be the escalation receiver or administrator of the escalation instance.
identifier
- A string representation of the task or escalation instance ID that is used to identify the object.property
- The BinaryCustomProperty
object.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
void setBinaryCustomProperty(TKIID tkiid, BinaryCustomProperty property) throws ApplicationVetoException, IdWrongFormatException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to tasks beyond those provided and managed by the task manager. Binary custom properties allow, for example, to attach a Java object to a task instance. Binary custom properties cannot be searched for directly. It is, however, possible to specify an additional queryable string.
Custom properties can be provided in any state of the task instance. The parent application may, however, reject to set a property. The caller must be the owner, starter, editor, or administrator of the task instance.
tkiid
- The task instance ID that is used to identify the task instance.property
- The BinaryCustomProperty
object.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
void setBinaryCustomProperty(ESIID esiid, BinaryCustomProperty property) throws ApplicationVetoException, IdWrongFormatException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, UnexpectedFailureException, CommunicationException
Custom properties allow a user to add additional properties to escalations beyond those provided and managed by the task manager. Binary custom properties allow, for example, to attach a Java object to an escalation instance. Binary custom properties cannot be searched for directly. It is, however, possible to specify an additional queryable string.
Custom properties can be provided in any state of the escalation instance. The parent application may, however, reject to set a property. The caller must be the escalation receiver or administrator of the escalation instance.
esiid
- The escalation instance ID that is used to identify the escalation instance.property
- The BinaryCustomProperty
object.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
void setFaultMessage(java.lang.String tkiid, java.lang.String faultName, ClientObjectWrapper faultMessage) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, InvalidQNameException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
complete
for information on how to
complete a task instance.
Any previously stored fault or output message is deleted.
The task instance must be a collaboration or to-do task. Collaboration and to-do task instances are also known as human and participating task instances.
The task instance must be in the claimed state. It can be escalated. The caller must be the owner, an editor, or an administrator of the task instance.
tkiid
- A string representation of the task instance ID.
This string is used
to identify the task 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 task. Refer
to getFaultNames
.faultMessage
- The fault message.
The object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
InvalidQNameException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void setFaultMessage(TKIID tkiid, java.lang.String faultName, ClientObjectWrapper faultMessage) throws ApplicationVetoException, IdWrongFormatException, InvalidQNameException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
complete
for information on how to
complete a task instance.
Any previously stored fault or output message is deleted.
The task instance must be in the claimed state. It can be escalated. The caller must be the owner, an editor, or an administrator of the task instance.
tkiid
- The task instance ID that is used
to identify the task 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 task. Refer
to getFaultNames
.faultMessage
- The fault message.
The object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
InvalidQNameException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void setInputMessage(java.lang.String tkiid, ClientObjectWrapper inputMessage) throws ApplicationVetoException, DataHandlingException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
startTask
or claim
for information on how to start or claim a task instance.
Any previously stored input message is deleted.
The task instance must be in the inactive state. It can be a collaboration, invocation, or to-do task. The caller must be the originator, a potential starter, or an administrator of the task instance.
Note that ollaboration, invocation, and to-do task instances are also known as human, originating, and participating task instances.
tkiid
- A string representation of the task instance ID.
This string is used
to identify the task instance whose input message is to be set.inputMessage
- The input message.
The object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
DataHandlingException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void setInputMessage(TKIID tkiid, ClientObjectWrapper inputMessage) throws ApplicationVetoException, DataHandlingException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
startTask
or claim
for information on how to start or claim a task instance.
Any previously stored input message is deleted.
The task instance must be in the inactive state. It can be a collaboration, invocation, or to-do task. The caller must be the originator, a potential starter, or an administrator of the task instance.
Note that ollaboration, invocation, and to-do task instances are also known as human, originating, and participating task instances.
tkiid
- The object ID of the task instance whose input message is to be set.inputMessage
- The input message.
The object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
DataHandlingException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void setOutputMessage(java.lang.String tkiid, ClientObjectWrapper outputMessage) throws ApplicationVetoException, DataHandlingException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
complete
for information on how to complete a task instance.
Any previously stored output or fault message is deleted.
The task instance must be in the claimed state. It can be escalated. The caller must be the owner, an editor, or an administrator of the task instance.
tkiid
- A string representation of the task instance ID.
This string is used
to identify the task instance whose output message is to be set.outputMessage
- The output message.
The object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
DataHandlingException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void setOutputMessage(TKIID tkiid, ClientObjectWrapper outputMessage) throws ApplicationVetoException, DataHandlingException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
complete
for information on how to complete a task instance.
Any previously stored output or fault message is deleted.
The task instance must be in the claimed state. It can be escalated. The caller must be the owner, an editor, or an administrator of the task instance.
tkiid
- The object ID of the task instance whose output message is to be set.outputMessage
- The output message.
The object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
DataHandlingException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void setSubstitutes(java.util.List substitutes) throws ParameterNullException, StaffServiceCannotAccessVMMException, StaffServiceSubstitutionNotEnabledException, StaffServiceRuntimeException, SubstituteDoesNotExistException, UserDoesNotExistException, UnexpectedFailureException, CommunicationException
substitutes
- A list of users that are substitutes of the logged-on user.
The substitutes that are provided replace any substitutes that are already set.
To remove the substitutes that are set, specify an empty list.
The user IDs of the substitutes are checked but the check may be executed case insensitively. The check can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments' custom property of the Human Task Manager configuration to 'true'.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ParameterNullException
StaffServiceCannotAccessVMMException
StaffServiceSubstitutionNotEnabledException
StaffServiceRuntimeException
SubstituteDoesNotExistException
UserDoesNotExistException
UnexpectedFailureException
void setSubstitutes(java.lang.String userID, java.util.List substitutes) throws NotAuthorizedException, ParameterNullException, StaffServiceCannotAccessVMMException, StaffServiceSubstitutionNotEnabledException, StaffServiceRuntimeException, SubstituteDoesNotExistException, UserDoesNotExistException, UnexpectedFailureException, CommunicationException
If setting substitutes is not restricted to administrators, then everybody can set the substitutes of any user.
If setting substitutes is restricted to administrators, then only task the task system administrators can set the substitutes of arbitrary users. A user may, however, always modify his/her substitutes.
userID
- The name of the user whose substitutes are to be set.
It is checked whether the user exists but the check may be executed case insensitively.substitutes
- A list of users that are substitutes of the specified user.
The substitutes that are provided replace any substitutes that are already set.
To remove the substitutes that are set, specify an empty list.
The user IDs of the substitutes are checked but the check may be executed case insensitively. The check can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments' custom property of the Human Task Manager configuration to 'true'.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
NotAuthorizedException
ParameterNullException
StaffServiceCannotAccessVMMException
StaffServiceSubstitutionNotEnabledException
StaffServiceRuntimeException
SubstituteDoesNotExistException
UserDoesNotExistException
UnexpectedFailureException
void startTask(java.lang.String tkiid, ClientObjectWrapper input, ReplyHandlerWrapper replyHandler) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, IdWrongFormatException, IdWrongTypeException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, SCAServiceAccessFailureException, SCAServiceResultErrorException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be in the inactive state. The caller must be a potential starter, the originator, or an administrator of the task. When the task is an invocation aka originating task instance, then the caller becomes the starter of the task.
tkiid
- A string representation of the task instance ID that is used
to identify the task instance.input
- The input message.
The object wrapped by the ClientObjectWrapper must be serializable.replyHandler
- The reply handler to be used to send the result of execution back to the
caller. "null" must be passed if no reply handler is provided.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
SCAServiceAccessFailureException
SCAServiceResultErrorException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void startTask(TKIID tkiid, ClientObjectWrapper input, ReplyHandlerWrapper replyHandler) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, IdWrongFormatException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, SCAServiceAccessFailureException, SCAServiceResultErrorException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be in the inactive state. The caller must be a potential starter, the originator, or an administrator of the task. When the task is an invocation aka originating task instance, then the caller becomes the starter of the task.
tkiid
- The task instance ID that is used to identify the task instance.input
- The input message.
The object wrapped by the ClientObjectWrapper must be serializable.replyHandler
- The reply handler to be used to send the result of execution back to the
caller. "null" must be passed if no reply handler is provided.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
SCAServiceAccessFailureException
SCAServiceResultErrorException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void startTaskAsSubTask(java.lang.String tkiid, java.lang.String parentTaskID, ClientObjectWrapper input) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, IdWrongFormatException, IdWrongTypeException, InvalidApplicationStateException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, SCAServiceAccessFailureException, SCAServiceResultErrorException, SubTasksNotSupportedException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The subtask must be a collaboration or stand-alone invocation task. An invocation task must have been derived from a task template that has not been created spontaneously. The parent task instance must be a collaboration or to-do task in the claimed state. It can be escalated or already waiting for a subtask. It can, however, not be suspended.
Note that collaboration, invocation, and to-do task instances are also known as human, originating, amd participating task instances.
A subtask can only be
started when the parent task supports subtask creation - refer to Task
to view the
task instance properties.
The subtask instance must be in the inactive state. When started it will be in the ready or running state. The caller must be a potential starter, the originator, or an administrator of the subtask and an owner or administrator of the parent task instance. When the task is an invocation aka originating task instance, then the caller becomes the starter of the task.
tkiid
- A string representation of the task instance ID that is used
to identify the subtask instance.parentTaskID
- A string representation of the task instance ID that identifies
the parent task instance.input
- The input message.
The object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
IdWrongTypeException
InvalidApplicationStateException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
SCAServiceAccessFailureException
SCAServiceResultErrorException
SubTasksNotSupportedException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void startTaskAsSubTask(TKIID tkiid, TKIID parentTaskID, ClientObjectWrapper input) throws AdministratorCannotBeResolvedException, ApplicationVetoException, CannotCreateWorkItemException, IdWrongFormatException, InvalidApplicationStateException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, ObjectDoesNotExistException, SCAServiceAccessFailureException, SCAServiceResultErrorException, SubTasksNotSupportedException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, CommunicationException
The subtask must be a collaboration or stand-alone invocation task. An invocation task must have been derived from a task template that has not been created spontaneously. The parent task instance must be a collaboration or to-do task in the claimed state. It can be escalated or already waiting for a subtask. It can, however, not be suspended.
Collaboration, invocation, and to-do task instances are also known as human, originating, and participating task instances.
A subtask can only be
started when the parent task supports subtask creation - refer to Task
to view the
task instance properties.
The subtask instance must be in the inactive state. When started it will be in the ready or running state. The caller must be a potential starter, the originator, or an administrator of the subtask and an owner or administrator of the parent task instance. When the task is an invocation aka originating task instance, then the caller becomes the starter of the task.
tkiid
- The task instance ID that is used to identify the subtask instance.parentTaskID
- The task instance ID that identifies the parent task instance.input
- The input message.
The object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
InvalidApplicationStateException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
ObjectDoesNotExistException
SCAServiceAccessFailureException
SCAServiceResultErrorException
SubTasksNotSupportedException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
void startTaskTemplate(java.lang.String tktid) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be an administrator of the task template. The task template must be stopped.
tktid
- A string representation of the object ID of the task template to be started.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void startTaskTemplate(TKTID tktid) throws ApplicationVetoException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be an administrator of the task template. The task template must be stopped.
tktid
- The object ID of the task template which is to be stopped.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void stopTaskTemplate(java.lang.String tktid) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be an administrator of the task template. The task template must be started.
tktid
- A string representation of the object ID of the task template to be stopped.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void stopTaskTemplate(TKTID tktid) throws ApplicationVetoException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be an administrator of the task template. The task template must be started.
tktid
- The object ID of the task template which is to be stopped.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void suspend(java.lang.String tkiid) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance can be in the ready or claimed state. It can be escalated or be waiting for subtasks to complete. The caller can be the owner, originator, or administrator of the task instance.
Note that escalation timers continue to run.
tkiid
- A string representation of the task instance ID to be suspended.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void suspend(TKIID tkiid) throws ApplicationVetoException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance can be in the ready or claimed state. It can be escalated or be waiting for subtasks to complete. The caller can be the owner, originator, or administrator of the task instance.
Note that escalation timers continue to run.
tkiid
- The object ID of the task instance to be suspended.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void suspend(java.lang.String tkiid, java.lang.String duration) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance can be in the ready or claimed state. It can be escalated or be waiting for subtasks to complete. The caller can be the owner, originator, or administrator of the task instance.
The task is then suspended for the specified duration or until an explicit resume request is issued.
Note that escalation timers continue to run.
tkiid
- A string representation of the task instance ID to be suspended.duration
- The time for which the task instance is to be suspended. Its format
depends on the calendar that is used and may, for example, be "5days". When the time
has passed, the task instance is automatically resumed.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
void suspend(TKIID tkiid, java.lang.String duration) throws ApplicationVetoException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance can be in the ready or claimed state. It can be escalated or be waiting for subtasks to complete. The caller can be the owner, originator, or administrator of the task instance.
The task is then suspended for the specified duration or until an explicit resume request is issued.
Note that escalation timers continue to run.
tkiid
- The object ID of the task instance to be suspended.duration
- The time for which the task instance is to be suspended. Its format
depends on the calendar that is used and may, for example, be "5days". When the time
has passed, the task instance is automatically resumed.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
void suspend(java.lang.String tkiid, int duration) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, InvalidParameterException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance can be in the ready or claimed state. It can be escalated or be waiting for subtasks to complete. The caller can be the owner, originator, or administrator of the task instance.
The task is then suspended for the specified duration or until an explicit resume request is issued.
Note that escalation timers continue to run.
tkiid
- A string representation of the task instance ID to be suspended.duration
- The seconds for which the task instance is to be suspended. When the time
has passed, the task instance is automatically resumed.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
InvalidParameterException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void suspend(TKIID tkiid, int duration) throws ApplicationVetoException, IdWrongFormatException, InvalidParameterException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance can be in the ready or claimed state. It can be escalated or be waiting for subtasks to complete. The caller can be the owner, originator, or administrator of the task instance.
The task is then suspended for the specified duration or until an explicit resume request is issued.
Note that escalation timers continue to run.
tkiid
- The object ID of the task instance to be suspended.duration
- The seconds for which the task instance is to be suspended. When the time
has passed, the task instance is automatically resumed.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
InvalidParameterException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void suspend(java.lang.String tkiid, java.util.Calendar deadline) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance can be in the ready or claimed state. It can be escalated or be waiting for subtasks to complete. The caller can be the owner, originator, or administrator of the task instance.
The task is then suspended until the specified point in time or until an explicit resume request is issued.
Note that escalation timers continue to run.
tkiid
- A string representation of the task instance to be suspended.deadline
- The time up to which the task instance is to be suspended. When the specified
time has been reached, the task instance is automatically resumed.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
void suspend(TKIID tkiid, java.util.Calendar deadline) throws ApplicationVetoException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance can be in the ready or claimed state. It can be escalated or be waiting for subtasks to complete. The caller can be the owner, originator, or administrator of the task instance.
The task is then suspended until the specified point in time or until an explicit resume request is issued.
Note that escalation timers continue to run.
tkiid
- The object ID of the task instance to be suspended.deadline
- The time up to which the task instance is to be suspended. When the specified
time has been reached, the task instance is automatically resumed.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
void suspendAndCancelClaim(java.lang.String tkiid, java.lang.String duration, boolean keepTaskData) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be in the claimed state. It can be escalated or be waiting for subtasks to complete. When the task instance is automatically resumed after the duration passed, it is returned to the ready state. When the task instance is resumed on request before the duration has passed, then the task instance remains claimed.
If specified, any previously stored output or fault message is kept.
The caller can be the owner or administrator of the task instance.
tkiid
- A string representation of the task instance ID to be suspended.duration
- The time for which the task instance is to be suspended. Its format
depends on the calendar that is used and may, for example, be "5days". When the time
has passed, the task instance is automatically resumed.keepTaskData
- Specifies whether data saved for the claimed task instance is to be kept.
True states that any output or fault message set is to be kept.
False states that any output or fault message set is to be deleted.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
void suspendAndCancelClaim(TKIID tkiid, java.lang.String duration, boolean keepTaskData) throws ApplicationVetoException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be in the claimed state. It can be escalated or be waiting for subtasks to complete. When the task instance is automatically resumed after the duration passed, it is returned to the ready state. When the task instance is resumed on request before the duration has passed, then the task instance remains claimed.
If specified, any previously stored output or fault message is kept.
The caller can be the owner or administrator of the task instance.
tkiid
- The object ID of the task instance to be suspended.duration
- The time for which the task instance is to be suspended. Its format
depends on the calendar that is used and may, for example, be "5days". When the time
has passed, the task instance is automatically resumed.keepTaskData
- Specifies whether data saved for the claimed task instance is to be kept.
True states that any output or fault message set is to be kept.
False states that any output or fault message set is to be deleted.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
void suspendAndCancelClaim(java.lang.String tkiid, int duration, boolean keepTaskData) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, InvalidParameterException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be in the claimed state. It can be escalated or be waiting for subtasks to complete. When the task instance is automatically resumed after the duration passed, it is returned to the ready state. When the task instance is resumed on request before the duration has passed, then the task instance remains claimed.
If specified, any previously stored output or fault message is kept.
The caller can be the owner or administrator of the task instance.
tkiid
- A string representation of the task instance ID to be suspended.duration
- The seconds for which the task instance is to be suspended. When the time
has passed, the task instance is automatically resumed.keepTaskData
- Specifies whether data saved for the claimed task instance is to be kept.
True states that any output or fault message set is to be kept.
False states that any output or fault message set is to be deleted.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
InvalidParameterException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void suspendAndCancelClaim(TKIID tkiid, int duration, boolean keepTaskData) throws ApplicationVetoException, IdWrongFormatException, InvalidParameterException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be in the claimed state. It can be escalated or be waiting for subtasks to complete. When the task instance is automatically resumed after the duration passed, it is returned to the ready state. When the task instance is resumed on request before the duration has passed, then the task instance remains claimed.
If specified, any previously stored output or fault message is kept.
The caller can be the owner or administrator of the task instance.
tkiid
- The object ID of the task instance to be suspended.duration
- The seconds for which the task instance is to be suspended. When the time
has passed, the task instance is automatically resumed.keepTaskData
- Specifies whether data saved for the claimed task instance is to be kept.
True states that any output or fault message set is to be kept.
False states that any output or fault message set is to be deleted.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
InvalidParameterException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void suspendAndCancelClaim(java.lang.String tkiid, java.util.Calendar deadline, boolean keepTaskData) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be in the claimed state. It can be escalated or be waiting for subtasks to complete. When the task instance is automatically resumed after the duration passed, it is returned to the ready state. When the task instance is resumed on request before the duration has passed, then the task instance remains claimed.
If specified, any previously stored output or fault message is kept.
The caller can be the owner or administrator of the task instance.
tkiid
- A string representation of the task instance ID to be suspended.deadline
- The time up to which the task instance is to be suspended. When the specified
time has been reached, the task instance is automatically resumed and returned to
the ready state.keepTaskData
- Specifies whether data saved for the claimed task instance is to be kept.
True states that any output or fault message set is to be kept.
False states that any output or fault message set is to be deleted.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
void suspendAndCancelClaim(TKIID tkiid, java.util.Calendar deadline, boolean keepTaskData) throws ApplicationVetoException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance must be in the claimed state. It can be escalated or be waiting for subtasks to complete. When the task instance is automatically resumed after the duration passed, it is returned to the ready state. When the task instance is resumed on request before the duration has passed, then the task instance remains claimed.
If specified, any previously stored output or fault message is kept.
The caller can be the owner or administrator of the task instance.
tkiid
- The object ID of the task instance to be suspended.deadline
- The time up to which the task instance is to be suspended. When the specified
time has been reached, the task instance is automatically resumed and returned to the
ready state.keepTaskData
- Specifies whether data saved for the claimed task instance is to be kept.
True states that any output or fault message set is to be kept.
False states that any output or fault message set is to be deleted.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
void terminate(java.lang.String tkiid) throws ApplicationVetoException, IdWrongFormatException, IdWrongTypeException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance can be in the ready, claimed, or running state. It can be escalated or suspended. It cannot be an inline task or a stand-alone task with "child" autonomy. The caller can be the owner, starter, originator, or administrator of the task instance.
tkiid
- A string representation of the object ID of the task instance to be terminated.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void terminate(TKIID tkiid) throws ApplicationVetoException, IdWrongFormatException, NotAuthorizedException, ObjectDoesNotExistException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The task instance can be in the ready, claimed, or running state. It can be escalated or suspended. It cannot be an inline task or a stand-alone task with "child" autonomy. The caller can be the owner, starter, originator, or administrator of the task instance.
tkiid
- The object ID of the task instance to be terminated.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
void transferWorkItem(java.lang.String identifier, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner) throws ApplicationVetoException, EverybodyWorkItemException, IdWrongFormatException, IdWrongTypeException, InvalidAssignmentReasonException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, WorkItemDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, TaskDelegationNotSupportedException, WorkItemManagerException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
When work items of a task instance are transferred, then the caller must be an owner, starter, originator, or administrator of the task instance. The task can be escalated. suspended, or waiting for subtasks.
When work items of an escalation instance are transferred, then the caller must be an administrator of the associated task instance. "Escalation receiver" work items can be transferred when the task is escalated, that is, the escalation is in the escalated state. An e-mail is not sent to the user or group that receives the transferred work item.
The following specific rules apply for the transfer of work items:
identifier
- A string representation of the task or escalation instance ID that is used to identify
the work item to be transferred.assignmentReason
- The reason why the work item is assigned - refer to
WorkItem.getAssignmentReason
for valid values.fromOwner
- The user ID or the name of the group the work item currently belongs to.toOwner
- The user ID or the name of the group the work item is to be transferred to.
Work items can be transferred from a user to a user or from a group of users to a group of users.
If a user work item is transferred, it is checked whether the user transferred to
exists but the check may be executed case insensitively.
The check can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments'
custom property of the Human Task Manager configuration to 'true'.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
EverybodyWorkItemException
IdWrongFormatException
IdWrongTypeException
InvalidAssignmentReasonException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
WorkItemDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
TaskDelegationNotSupportedException
WorkItemManagerException
WrongKindException
WrongStateException
UnexpectedFailureException
void transferWorkItem(ESIID esiid, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner) throws ApplicationVetoException, EverybodyWorkItemException, IdWrongFormatException, InvalidAssignmentReasonException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, WorkItemDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, TaskDelegationNotSupportedException, WorkItemManagerException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be an administrator of the associated task instance. "Escalation receiver" work items can be transferred when the task is escalated, that is, the escalation is in the escalated state. An e-mail is not sent to the user or group that receives the transferred work item.
esiid
- The escalation instance ID that is used to identify
the work item to be transferred.assignmentReason
- The reason why the work item is assigned - refer to
WorkItem.getAssignmentReason
.fromOwner
- The user ID or the name of the group the work item currently belongs to.toOwner
- The user ID or the name of the group the work item is to be transferred to.
Work items can be transferred from a user to a user or from a group of users to a group of users.
If a user work item is transferred, it is checked whether the user transferred to
exists but the check may be executed case insensitively.
The check can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments'
custom property of the Human Task Manager configuration to 'true'.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
EverybodyWorkItemException
IdWrongFormatException
InvalidAssignmentReasonException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
WorkItemDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
TaskDelegationNotSupportedException
WorkItemManagerException
WrongKindException
WrongStateException
UnexpectedFailureException
void transferWorkItem(TKIID tkiid, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner) throws ApplicationVetoException, EverybodyWorkItemException, IdWrongFormatException, InvalidAssignmentReasonException, InvalidLengthException, NotAuthorizedException, UserDoesNotExistException, WorkItemDoesNotExistException, ObjectDoesNotExistException, ParameterNullException, TaskDelegationNotSupportedException, WorkItemManagerException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
The caller must be an owner, starter, originator, or administrator of the task instance. The task can be escalated. suspended, or waiting for subtasks.
The following specific rules apply for the transfer of work items:
tkiid
- The task instance ID that is used to identify
the work item to be transferred.assignmentReason
- The reason why the work item is assigned - refer to
WorkItem.getAssignmentReason
.fromOwner
- The user ID or the name of the group the work item currently belongs to.toOwner
- The user ID or the name of the group the work item is to be transferred to.
Work items can be transferred from a user to a user or from a group of users to a group of users.
If a user work item is transferred, it is checked whether the user transferred to
exists but the check may be executed case insensitively.
The check can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments'
custom property of the Human Task Manager configuration to 'true'.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
EverybodyWorkItemException
IdWrongFormatException
InvalidAssignmentReasonException
InvalidLengthException
NotAuthorizedException
UserDoesNotExistException
WorkItemDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
TaskDelegationNotSupportedException
WorkItemManagerException
WrongKindException
WrongStateException
UnexpectedFailureException
java.util.List transferWorkItem(java.lang.String[] identifiers, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner) throws IdWrongFormatException, IdWrongTypeException, InvalidAssignmentReasonException, InvalidLengthException, ParameterNullException, WorkItemNotFoundException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
Note:
All transfer work item operations are executed within the current transaction.
If a transaction timeout occurs, then all already executed transfer operations are rolled back.
Because of this, you may consider to use
bulkTransferWorkItem
.
When work items of a task instance are transferred, then the caller must be an owner, starter, originator, or administrator of the task instances. The task can be escalated. suspended, or waiting for subtasks.
When work items of an escalation instance are transferred, then the caller must be an administrator of the associated task instances. "Escalation receiver" work items can be transferred when the task is escalated, that is, the escalation is in the escalated state. An e-mail is not sent to the user or group that receives the transferred work item.
The following specific rules apply for the transfer of work items:
identifiers
- An array of either escalation instance IDs or task instance IDs that
are used to identify the work items to be transferred.assignmentReason
- The reason why the work item is assigned - refer to
WorkItem.getAssignmentReason
.fromOwner
- The user ID or the name of the group the work item currently belongs to.toOwner
- The user ID or the name of the group the work item is to be transferred to.
Work items can be transferred from a user to a user or from a group of users to a group of users.
If a user work item is transferred, it is checked whether the user transferred to
exists but the check may be executed case insensitively.
The check can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments'
custom property of the Human Task Manager configuration to 'true'.
EscalationResult
or to
TaskResult
.
If a single transfer operation fails because any of the following exceptions has been thrown, then the result object contains the respective exception. Otherwise, the TaskException property is null.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
IdWrongTypeException
InvalidAssignmentReasonException
InvalidLengthException
ParameterNullException
WorkItemNotFoundException
WorkItemManagerException
UnexpectedFailureException
java.util.List transferWorkItem(ESIID[] esiids, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner) throws IdWrongFormatException, InvalidAssignmentReasonException, InvalidLengthException, ParameterNullException, WorkItemNotFoundException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
Note:
All transfer work item operations are executed within the current transaction.
If a transaction timeout occurs, then all already executed transfer operations are rolled back.
Because of this, you may consider to use
bulkTransferWorkItem
.
The caller must be an administrator of the associated task instances. "Escalation receiver" work items can be transferred when the task is escalated, that is, the escalation is in the escalated state. An e-mail is not sent to the user or group that receives the transferred work item.
esiids
- An array of escalation instance IDs that are used to identify
the work items to be transferred.assignmentReason
- The reason why the work item is assigned - refer to
WorkItem.getAssignmentReason
.fromOwner
- The user ID or the name of the group the work item currently belongs to.toOwner
- The user ID or the name of the group the work item is to be transferred to.
Work items can be transferred from a user to a user or from a group of users to a group of users.
If a user work item is transferred, it is checked whether the user transferred to
exists but the check may be executed case insensitively.
The check can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments'
custom property of the Human Task Manager configuration to 'true'.
EscalationResult
.
If a single transfer operation fails because any of the following exceptions has been thrown, then the result object contains the respective exception. Otherwise, the TaskException property is null.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
InvalidAssignmentReasonException
InvalidLengthException
ParameterNullException
WorkItemNotFoundException
WorkItemManagerException
UnexpectedFailureException
java.util.List transferWorkItem(TKIID[] tkiids, int assignmentReason, java.lang.String fromOwner, java.lang.String toOwner) throws IdWrongFormatException, InvalidAssignmentReasonException, InvalidLengthException, ParameterNullException, WorkItemNotFoundException, WorkItemManagerException, UnexpectedFailureException, CommunicationException
Note:
All transfer work item operations are executed within the current transaction.
If a transaction timeout occurs, then all already executed transfer operations are rolled back.
Because of this, you may consider to use
bulkTransferWorkItem
.
The caller must be an owner, starter, originator, or administrator of the task instances. The task can be escalated. suspended, or waiting for subtasks.
The following specific rules apply for the transfer of work items:
tkiids
- An array of task instance IDs that are used to identify
the work items to be transferred.assignmentReason
- The reason why the work item is assigned - refer to
WorkItem.getAssignmentReason
.fromOwner
- The user ID or the name of the group the work item currently belongs to.toOwner
- The user ID or the name of the group the work item is to be transferred to.
Work items can be transferred from a user to a user or from a group of users to a group of users.
If a user work item is transferred, it is checked whether the user transferred to
exists but the check may be executed case insensitively.
The check can be suppressed by setting the 'SupportVirtualUserIdsForPeopleAssignments'
custom property of the Human Task Manager configuration to 'true'.
TaskResult
.
If a single transfer operation fails because any of the following exceptions has been thrown, then the result object contains the respective exception. Otherwise, the TaskException property is null.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
IdWrongFormatException
InvalidAssignmentReasonException
InvalidLengthException
ParameterNullException
WorkItemNotFoundException
WorkItemManagerException
UnexpectedFailureException
void update(Task task) throws ApplicationVetoException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, PropertyVetoException, WrongKindException, WrongStateException, UnexpectedFailureException, CommunicationException
setCustomProperty
.
task
- The task instance and the properties to be updated.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
PropertyVetoException
WrongKindException
WrongStateException
UnexpectedFailureException
void update(java.lang.String tkiid, TaskModel taskModel, java.lang.String applicationName, java.lang.String parentContext, ClientObjectWrapper input) throws ApplicationVetoException, CannotCreateWorkItemException, IdWrongFormatException, IdWrongTypeException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, com.ibm.task.plugins.TaskDeploymentException, com.ibm.task.plugins.TELValidationException, CommunicationException
The task must still be in the inactive state. The caller must be the originator of the task instance.
tkiid
- A string representation of the task instance ID that is used
to identify the task instance to be updated.taskModel
- The model that specifies the task properties and their new values.applicationName
- The name of the enterprise application that contains the message
or business calendar definitions used in the TaskModel.
If the message definitions are simple types only or if you do not use a business
calendar, null may be specified.parentContext
- The object ID (ACOID) or the name of the application component to be associated.
If not specified, the parent context of the updated task instance is kept.input
- The input message.
If not specified, the input message of the updated task instance is kept, if any.
Note that the object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
com.ibm.task.plugins.TaskDeploymentException
com.ibm.task.plugins.TELValidationException
void update(TKIID tkiid, TaskModel taskModel, java.lang.String applicationName, java.lang.String parentContext, ClientObjectWrapper input) throws ApplicationVetoException, CannotCreateWorkItemException, IdWrongFormatException, IdWrongTypeException, InvalidLengthException, NotAuthorizedException, ObjectDoesNotExistException, ParameterNullException, WrongKindException, WrongMessageTypeException, WrongStateException, UnexpectedFailureException, com.ibm.task.plugins.TaskDeploymentException, com.ibm.task.plugins.TELValidationException, CommunicationException
The task must still be in the inactive state. The caller must be the originator of the task instance.
tkiid
- The task instance ID that is used
to identify the task instance to be updated.taskModel
- The model that specifies the task properties and their new values.applicationName
- The name of the enterprise application that contains the message
or business calendar definitions used in the TaskModel.
If the message definitions are simple types only or if you do not use a business
calendar, null may be specified.parentContext
- The object ID (ACOID) or the name of the application component to be associated.
If not specified, the parent context of the updated task instance is kept.input
- The input message.
If not specified, the input message of the updated task instance is kept, if any.
Note that the object wrapped by the ClientObjectWrapper must be serializable.
CommunicationException
- Thrown when the method failed due to a communication or system-level failure.
ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
com.ibm.task.plugins.TaskDeploymentException
com.ibm.task.plugins.TELValidationException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |