com.ibm.task.api
Interface HumanTaskManagerDelegate


public interface HumanTaskManagerDelegate

HumanTaskManagerDelegate wraps the functions of the Human Task Manager API and hides the details of setting up the communication.


Method Summary
 ClientObjectWrapper callTask(java.lang.String tkiid, ClientObjectWrapper input)
          Synchronously executes a previously created originating task using a string representation of the task instance ID.
 ClientObjectWrapper callTask(TKIID tkiid, ClientObjectWrapper input)
          Synchronously executes a previously created originating task 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.
 void cancelClaim(TKIID tkiid)
          Cancels the claim of a task instance using the task instance ID.
 ClientObjectWrapper claim(java.lang.String tkiid)
          Claims a ready participating or human task instance for user processing using a string representation of the task instance ID.
 Task claim(java.lang.String whereClause, java.lang.String orderByClause, java.util.TimeZone timeZone)
          Claims some ready participating or human task instance for user processing.
 ClientObjectWrapper claim(TKIID tkiid)
          Claims a ready participating or human task instance for user processing using the task instance ID.
 void complete(java.lang.String tkiid)
          Completes a claimed task instance using a string representation of the task instance ID.
 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 a string representation of the task instance ID.
 void complete(TKIID 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(TKIID 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.
 ClientObjectWrapper createAndCallTask(java.lang.String name, java.lang.String namespace, ClientObjectWrapper input)
          Creates and synchronously executes an originating 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.
 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 getInputMessage, getOutputMessage, getFaultMessage.
 ClientObjectWrapper createMessage(TKIID tkiid, java.lang.String messageTypeName)
          Deprecated. Use getInputMessage, getOutputMessage, getFaultMessage.
 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 for general usage.
 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(java.lang.String tkiid, int assignmentReason, java.lang.String userID)
          Creates a work item for the specified task instance using a string representation of the task instance ID.
 void createWorkItem(TKIID tkiid, int assignmentReason, java.lang.String userID)
          Creates a work item for the specified task instance using the task instance ID.
 void delete(java.lang.String identifier)
          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 deleteWorkItem(java.lang.String tkiid, int assignmentReason, java.lang.String userID)
          Deletes the specified work item using a string representation of the task instance ID.
 void deleteWorkItem(TKIID tkiid, int assignmentReason, java.lang.String userID)
          Deletes the specified 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.
 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(java.lang.String[] tkiids)
          Returns the actions that can be called for the specified tasks in their current state by the logged-on user using string representations of the task 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(java.lang.String tkiid)
          Returns the actions that can be called in the current task instance state by the logged-on user using a string representation of the task instance 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.
 java.util.List getCustomProperties(java.lang.String tkiid)
          Retrieves all custom properties of the specified task instance using a string representation of the task instance ID.
 java.util.List getCustomProperties(TKIID tkiid)
          Retrieves all custom properties of the specified task instance using the task instance ID.
 java.lang.String getCustomProperty(java.lang.String tkiid, java.lang.String propertyName)
          Retrieves the named custom property of the specified task instance 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.util.List getCustomPropertyNames(java.lang.String tkiid)
          Retrieves the names of all custom properties of the specified task instance 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.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.
 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.
 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.
 StoredQuery getStoredQuery(java.lang.String storedQueryName)
          Retrieves the specified stored query definition.
 java.lang.String[] getStoredQueryNames()
          Retrieves the names of stored queries that are persistently stored in the database.
 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.
 StaffResultSet getUsersInRole(java.lang.String tkiid, int role)
          Retrieves the users that are members of the specified role for the specified task using a string representation of the task instance 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.
 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 system monitor for the human task manager component.
 boolean isUserInRole(java.lang.String 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 a string representation of the task instance 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.
 QueryResultSet query(java.lang.String storedQueryName, java.lang.Integer skipTuples)
          Calls the specified stored query and returns the qualifying object properties.
 QueryResultSet query(java.lang.String storedQueryName, java.lang.Integer skipTuples, java.lang.Integer threshold)
          Calls the specified stored query and returns the properties of objects in the specified range.
 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.
 void resume(java.lang.String tkiid)
          Resumes the execution of the specified suspended human or participating task instance using a string representation of the task instance ID.
 void resume(TKIID tkiid)
          Resumes the execution of the specified suspended human or participating task instance using the task instance ID.
 void setCustomProperty(java.lang.String tkiid, java.lang.String propertyName, java.lang.String propertyValue)
          Stores custom-specific values for the specified task 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 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 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 startTaskTemplate(java.lang.String tktid)
          This method starts a task template that has been created on-the-fly using a string representation of the task template ID.
 void startTaskTemplate(TKTID tktid)
          This method starts a task template that has been created on-the-fly using the task template ID.
 void stopTaskTemplate(java.lang.String tktid)
          This method stops a task template that has been created on-the-fly using a string representation of the task template ID.
 void stopTaskTemplate(TKTID tktid)
          This method stops a task template that has been created on-the-fly using the task template ID.
 void suspend(java.lang.String tkiid)
          Suspends the specified human or participating task instance using a string representation of the task instance ID.
 void suspend(TKIID tkiid)
          Suspends the specified human or participating task instance 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.
 void transferWorkItem(java.lang.String tkiid, int assignmentReason, java.lang.String fromUserID, java.lang.String toUserID)
          Transfers the specified work item to the specified user using a string representation of the task instance ID.
 void transferWorkItem(TKIID tkiid, int assignmentReason, java.lang.String fromUserID, java.lang.String toUserID)
          Transfers a work item for the specified task instance to the specified user 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 on-the-fly 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 on-the-fly using the task instance ID.
 

Method Detail

executeQuery

public void executeQuery(ExecutableQuery query)
                  throws CommunicationException,
                         ParameterNullException,
                         WorkItemManagerException,
                         UnexpectedFailureException
Retrieves selected object properties persistently stored in the database using a predefined query object.

Parameters:
query - The query specification

Throws:
CommunicationException
ParameterNullException
WorkItemManagerException
UnexpectedFailureException
Since:
6.0

callTask

public 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
Synchronously executes a previously created originating task using a string representation of the task instance ID. An input message can be passed to specify intial values for the task.

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 in the ready state. The caller must be a potential starter, the originator, or an administrator of the task instance.

Parameters:
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.

Returns:
ClientObjectWrapper - The output message that denotes the result of execution.
Throws:
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
Since:
6.0

callTask

public ClientObjectWrapper callTask(TKIID tkiid,
                                    ClientObjectWrapper input)
                             throws AdministratorCannotBeResolvedException,
                                    ApplicationVetoException,
                                    CannotCreateWorkItemException,
                                    FaultReplyException,
                                    IdWrongFormatException,
                                    InvalidLengthException,
                                    NotAuthorizedException,
                                    ObjectDoesNotExistException,
                                    SCAServiceAccessFailureException,
                                    SCAServiceResultErrorException,
                                    WrongKindException,
                                    WrongMessageTypeException,
                                    WrongStateException,
                                    UnexpectedFailureException,
                                    CommunicationException
Synchronously executes a previously created originating task using the task instance ID. An input message can be passed to specify intial values for the task.

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 in the ready state. The caller must be a potential starter, the originator, or an administrator of the task instance.

Parameters:
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.

Returns:
ClientObjectWrapper - The output message that denotes the result of execution.
Throws:
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
Since:
6.0

cancelClaim

public void cancelClaim(java.lang.String tkiid)
                 throws ApplicationVetoException,
                        IdWrongFormatException,
                        IdWrongTypeException,
                        NotAuthorizedException,
                        ObjectDoesNotExistException,
                        WrongKindException,
                        WrongStateException,
                        UnexpectedFailureException,
                        CommunicationException
Cancels the claim of a task instance using a string representation of the task instance ID.

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.

Parameters:
tkiid - A string representation of the task instance ID that is used to identify the task instance.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0 - introduced in 5.1.1

cancelClaim

public void cancelClaim(TKIID tkiid)
                 throws ApplicationVetoException,
                        IdWrongFormatException,
                        NotAuthorizedException,
                        ObjectDoesNotExistException,
                        WrongKindException,
                        WrongStateException,
                        UnexpectedFailureException,
                        CommunicationException
Cancels the claim of a task instance using the task instance ID.

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.

Parameters:
tkiid - The task instance ID that is used to identify the task instance.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0 - introduced in 5.1.1

claim

public ClientObjectWrapper claim(java.lang.String tkiid)
                          throws ApplicationVetoException,
                                 CannotCreateWorkItemException,
                                 IdWrongFormatException,
                                 IdWrongTypeException,
                                 NotAuthorizedException,
                                 ObjectDoesNotExistException,
                                 WrongKindException,
                                 WrongStateException,
                                 UnexpectedFailureException,
                                 CommunicationException
Claims a ready participating or human task instance for user processing using a string representation of the task instance ID. The task instance can be escalated.

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.

Parameters:
tkiid - A string representation of the task instance ID that is used to identify the task instance to be claimed.

Returns:
ClientObjectWrapper - The input message of the claimed task instance.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0 - introduced in 5.1.1

claim

public ClientObjectWrapper claim(TKIID tkiid)
                          throws ApplicationVetoException,
                                 CannotCreateWorkItemException,
                                 IdWrongFormatException,
                                 NotAuthorizedException,
                                 ObjectDoesNotExistException,
                                 WrongKindException,
                                 WrongStateException,
                                 UnexpectedFailureException,
                                 CommunicationException
Claims a ready participating or human task instance for user processing using the task instance ID. The task instance can be escalated.

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.

Parameters:
tkiid - The object ID of the task instance to be claimed.

Returns:
ClientObjectWrapper - The input message of the claimed task instance.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0 - introduced in 5.1.1

claim

public Task claim(java.lang.String whereClause,
                  java.lang.String orderByClause,
                  java.util.TimeZone timeZone)
           throws CannotCreateWorkItemException,
                  WorkItemManagerException,
                  UnexpectedFailureException,
                  CommunicationException
Claims some ready participating or human task instance for user processing. The task instance can be escalated.

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.

Parameters:
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:
  • Specify object ID constants as ID('string-rep-of-oid').
  • Specify timestamp constants as TS('yyyy-mm-ddThh:mm:ss') or as CURRENT_DATE for comparisons with the current date.
    The date and time parts of a TS definition are optional; either the date or the time must be specified. If no date part of a TS definition is specified, the current date is taken. Optional time values that are not specified are set to zero. The timestamp is 24 hours based. For example, TS('16:04') is the same as TS('2002-12-24T16:04:00') provided that the current date is December 24th, 2002.
    If a date part of a TS definition is specified, the year must consist of 4 letters; the month and day specifications are optional. Missing month and day specifications are set to 01. For example, specifying TS('2003') is the same as specifying TS('2003-01-01T00:00:00').
  • Specify binary constants as BIN('UTF-8 string').
  • Use constants instead of integer enumerations. For example, instead of specifying a task state expression "TASK.STATE=2" , specify "TASK.STATE=TASK.STATE.STATE_READY".

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

orderByClause - Sorts the query result set by the values of the columns you identify. The orderby-clause sorts the set of qualifying ready 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 process views - see the InfoCenter for details.

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

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

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

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

Returns:
Task - The task instance that is claimed. If there is no ready and not suspended task instance for the logged-on user, null is returned. Refer to Task to view the task instance properties.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

CannotCreateWorkItemException
WorkItemManagerException
UnexpectedFailureException
Since:
6.0

complete

public void complete(java.lang.String tkiid)
              throws ApplicationVetoException,
                     IdWrongFormatException,
                     IdWrongTypeException,
                     NotAuthorizedException,
                     ObjectDoesNotExistException,
                     WrongKindException,
                     WrongStateException,
                     UnexpectedFailureException,
                     CommunicationException
Completes a claimed task instance using a string representation of the task instance ID.

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.

Parameters:
tkiid - A string representation of the task instance ID that is used to identify the task instance to be completed.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0 - introduced in 5.1.1

complete

public void complete(TKIID tkiid)
              throws ApplicationVetoException,
                     IdWrongFormatException,
                     NotAuthorizedException,
                     ObjectDoesNotExistException,
                     WrongKindException,
                     WrongStateException,
                     UnexpectedFailureException,
                     CommunicationException
Completes a claimed task instance using a string representation of the task instance ID.

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.

Parameters:
tkiid - The object ID to identify the task instance to be completed.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0 - introduced in 5.1.1

complete

public void complete(java.lang.String tkiid,
                     ClientObjectWrapper output)
              throws ApplicationVetoException,
                     IdWrongFormatException,
                     IdWrongTypeException,
                     NotAuthorizedException,
                     ObjectDoesNotExistException,
                     ParameterNullException,
                     WrongKindException,
                     WrongMessageTypeException,
                     WrongStateException,
                     UnexpectedFailureException,
                     CommunicationException
Completes a claimed task instance using a string representation of the task instance ID and passes the result of user processing.

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.

Parameters:
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.

Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
Since:
6.0 - introduced in 5.1.1

complete

public void complete(TKIID tkiid,
                     ClientObjectWrapper output)
              throws ApplicationVetoException,
                     IdWrongFormatException,
                     NotAuthorizedException,
                     ObjectDoesNotExistException,
                     ParameterNullException,
                     WrongKindException,
                     WrongMessageTypeException,
                     WrongStateException,
                     UnexpectedFailureException,
                     CommunicationException
Completes a claimed task instance using a string representation of the task instance ID and passes the result of user processing.

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.

Parameters:
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.

Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
Since:
6.0 - introduced in 5.1.1

complete

public 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
Completes a claimed task instance using a string representation of the task instance ID and states the failing of user processing.

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.

Parameters:
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.

Throws:
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
Since:
6.0 - introduced in 5.1.1

complete

public void complete(TKIID tkiid,
                     java.lang.String faultName,
                     ClientObjectWrapper faultMessage)
              throws ApplicationVetoException,
                     IdWrongFormatException,
                     InvalidQNameException,
                     NotAuthorizedException,
                     ObjectDoesNotExistException,
                     ParameterNullException,
                     WrongKindException,
                     WrongMessageTypeException,
                     WrongStateException,
                     UnexpectedFailureException,
                     CommunicationException
Completes a claimed task instance using a string representation of the task instance ID and states the failing of user processing.

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.

Parameters:
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.

Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
InvalidQNameException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
Since:
6.0 - introduced in 5.1.1

createAndCallTask

public 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
Creates and synchronously executes an originating task instance. An input message can be passed to specify intial values for the task.

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.

Parameters:
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.

Returns:
ClientObjectWrapper - The output message to state the result of execution.
Throws:
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
Since:
6.0

createAndStartTask

public TKIID createAndStartTask(java.lang.String name,
                                java.lang.String namespace,
                                ClientObjectWrapper input,
                                ReplyHandlerWrapper replyHandler)
                         throws AdministratorCannotBeResolvedException,
                                ApplicationVetoException,
                                CannotCreateWorkItemException,
                                InvalidApplicationStateException,
                                InvalidLengthException,
                                NotAuthorizedException,
                                ObjectDoesNotExistException,
                                ParameterNullException,
                                SCAServiceAccessFailureException,
                                SCAServiceResultErrorException,
                                WrongKindException,
                                WrongMessageTypeException,
                                WrongStateException,
                                UnexpectedFailureException,
                                CommunicationException
Creates and starts a task instance.

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 originating task, then the caller also becomes the starter of the task.

Parameters:
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.

Returns:
TKIID - The task instance ID of the task created.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
InvalidApplicationStateException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
SCAServiceAccessFailureException
SCAServiceResultErrorException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
Since:
6.0

createAndStartTask

public TKIID createAndStartTask(TaskModel taskModel,
                                java.lang.String applicationName,
                                java.lang.String parentContext,
                                ClientObjectWrapper input,
                                ReplyHandlerWrapper replyHandler)
                         throws AdministratorCannotBeResolvedException,
                                ApplicationVetoException,
                                CannotCreateWorkItemException,
                                IdWrongTypeException,
                                InvalidLengthException,
                                NotAuthorizedException,
                                ObjectDoesNotExistException,
                                ParameterNullException,
                                WrongMessageTypeException,
                                UnexpectedFailureException,
                                com.ibm.task.plugins.TaskDeploymentException,
                                com.ibm.task.plugins.TELValidationException,
                                CommunicationException
Creates and starts a task from the specified task model.

The caller must have potential-instance-creator rights on the associated application component. The caller becomes the originator of the new task.

Parameters:
taskModel - The model that describes the task instance to be created on-the-fly.
applicationName - The name of the enterprise application that contains the message definitions. If the message definitions are simple types only, 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.

Returns:
TKIID - The task instance ID of the task created and run.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
IdWrongTypeException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongMessageTypeException
UnexpectedFailureException
com.ibm.task.plugins.TaskDeploymentException
com.ibm.task.plugins.TELValidationException
Since:
6.0.1

createFaultMessage

public ClientObjectWrapper createFaultMessage(java.lang.String tkiid,
                                              java.lang.String faultName)
                                       throws IdWrongFormatException,
                                              IdWrongTypeException,
                                              InvalidQNameException,
                                              NotAuthorizedException,
                                              ObjectDoesNotExistException,
                                              ParameterNullException,
                                              WrongKindException,
                                              WrongStateException,
                                              UnexpectedFailureException,
                                              CommunicationException
Creates a fault message for a fault that is defined by the specified task instance using a string representation of the task instance ID. This method creates a message that can be used when unsuccessfully completing a task - refer to complete.

The caller must be the owner, an editor, or an administrator of the task instance.

Parameters:
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.

Returns:
ClientObjectWrapper - The message created. An empty client object wrapper is returned, when the specified fault cannot be found for the task instance.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
InvalidQNameException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

createFaultMessage

public ClientObjectWrapper createFaultMessage(TKIID tkiid,
                                              java.lang.String faultName)
                                       throws IdWrongFormatException,
                                              InvalidQNameException,
                                              NotAuthorizedException,
                                              ObjectDoesNotExistException,
                                              ParameterNullException,
                                              WrongKindException,
                                              WrongStateException,
                                              UnexpectedFailureException,
                                              CommunicationException
Creates a fault message for a fault that is defined by the specified task instance using the task instance ID. This method creates a message that can be used when unsuccessfully completing a task - refer to complete.

The caller must be the owner, an editor, or an administrator of the task instance.

Parameters:
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.

Returns:
ClientObjectWrapper - The message created. An empty client object wrapper is returned, when the specified fault cannot be found for the task instance.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
InvalidQNameException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

createInputMessage

public ClientObjectWrapper createInputMessage(java.lang.String identifier)
                                       throws IdWrongFormatException,
                                              IdWrongTypeException,
                                              NotAuthorizedException,
                                              ObjectDoesNotExistException,
                                              WrongKindException,
                                              WrongStateException,
                                              UnexpectedFailureException,
                                              CommunicationException
Creates an input message for the specified task instance or template using a string representation of the task instance or template ID. For example, create a message that can be used when starting a task.

The caller must be the owner, a potential starter, the originator, or an administrator of the task instance.

Parameters:
identifier - A string representation of the task instance or template ID that is used to identify the task instance or template.

Returns:
ClientObjectWrapper - The message created. An empty client object wrapper is returned, when the task does not expect an input message.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

createInputMessage

public ClientObjectWrapper createInputMessage(TKIID tkiid)
                                       throws IdWrongFormatException,
                                              NotAuthorizedException,
                                              ObjectDoesNotExistException,
                                              WrongKindException,
                                              WrongStateException,
                                              UnexpectedFailureException,
                                              CommunicationException
Creates an input message for the specified task instance using the task instance ID. For example, create a message that can be used when starting a task.

The caller must be the owner, a potential starter, the originator, or an administrator of the task instance.

Parameters:
tkiid - The task instance ID that is used to identify the task instance.

Returns:
ClientObjectWrapper - The message created. An empty client object wrapper is returned, when the task does not expect an input message.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

createInputMessage

public ClientObjectWrapper createInputMessage(TKTID tktid)
                                       throws IdWrongFormatException,
                                              NotAuthorizedException,
                                              ObjectDoesNotExistException,
                                              WrongKindException,
                                              WrongStateException,
                                              UnexpectedFailureException,
                                              CommunicationException
Creates an input message for the specified task template using the task template ID. For example, create a message that can be used when starting a task.

The caller must be the owner, a potential starter, the originator, or an administrator of the task instance.

Parameters:
tktid - The task template ID that is used to identify the task template.

Returns:
ClientObjectWrapper - The message created. An empty client object wrapper is returned, when an input message is not expected.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

createMessage

public ClientObjectWrapper createMessage(java.lang.String tkiid,
                                         java.lang.String messageTypeName)
                                  throws IdWrongFormatException,
                                         IdWrongTypeException,
                                         NotAuthorizedException,
                                         ObjectDoesNotExistException,
                                         ParameterNullException,
                                         UnexpectedFailureException,
                                         CommunicationException
Deprecated. Use getInputMessage, getOutputMessage, getFaultMessage.

Creates a message defined by the specified task instance using a string representation of the task instance ID. For example, create a message that can be used when completing a task.

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

Parameters:
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.

Returns:
ClientObjectWrapper - The message created. An empty client object wrapper is returned, when the specified message type cannot be found.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
Since:
5.1.1

createMessage

public ClientObjectWrapper createMessage(TKIID tkiid,
                                         java.lang.String messageTypeName)
                                  throws IdWrongFormatException,
                                         NotAuthorizedException,
                                         ObjectDoesNotExistException,
                                         ParameterNullException,
                                         UnexpectedFailureException,
                                         CommunicationException
Deprecated. Use getInputMessage, getOutputMessage, getFaultMessage.

Creates a message defined by the specified task instance using the task instance ID. For example, create a message that can be used to complete a task instance.

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

Parameters:
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.

Returns:
ClientObjectWrapper - The message created. An empty client object wrapper is returned, when the specified message type cannot be found.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
Since:
5.1.1

createOutputMessage

public ClientObjectWrapper createOutputMessage(java.lang.String tkiid)
                                        throws IdWrongFormatException,
                                               IdWrongTypeException,
                                               NotAuthorizedException,
                                               ObjectDoesNotExistException,
                                               WrongKindException,
                                               WrongStateException,
                                               UnexpectedFailureException,
                                               CommunicationException
Creates an output message for the specified task instance using a string representation of the task instance ID. For example, create a message that can be used when completing a task.

The caller must be the owner, an editor, or an administrator of the task instance.

Parameters:
tkiid - A string representation of the task instance ID that is used to identify the task instance.

Returns:
ClientObjectWrapper - The message created. An empty client object wrapper is returned, when the task does not return an output message.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

createOutputMessage

public ClientObjectWrapper createOutputMessage(TKIID tkiid)
                                        throws IdWrongFormatException,
                                               NotAuthorizedException,
                                               ObjectDoesNotExistException,
                                               WrongKindException,
                                               WrongStateException,
                                               UnexpectedFailureException,
                                               CommunicationException
Creates an output message for the specified task instance using the task instance ID. For example, create a message that can be used when completing a task.

The caller must be the owner, an editor, or an administrator of the task instance.

Parameters:
tkiid - The task instance ID that is used to identify the task instance.

Returns:
ClientObjectWrapper - The message created. An empty client object wrapper is returned, when the task does not return an output message.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

createStoredQuery

public void createStoredQuery(java.lang.String storedQueryName,
                              java.lang.String selectClause,
                              java.lang.String whereClause,
                              java.lang.String orderByClause,
                              java.lang.Integer threshold,
                              java.util.TimeZone timeZone)
                       throws InvalidLengthException,
                              NotAuthorizedException,
                              ParameterNullException,
                              StoredQueryNameNotUniqueException,
                              UnexpectedFailureException,
                              CommunicationException
Creates a query definition and persistently stores it in the database for general usage. Only a task system administrator can create a stored query.

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

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

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

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

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

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

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

Parameters:
storedQueryName - The name of the stored query to be created; must not be greater than 64 bytes in UTF-8 format. The name must be unique.
selectClause - Describes the query result 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:
  • Specify object ID constants as ID('string-rep-of-oid').
  • Specify timestamp constants as TS('yyyy-mm-ddThh:mm:ss') or as CURRENT_DATE for comparisons with the current date.
    The date and time parts of a TS definition are optional; either the date or the time must be specified. If no date part of a TS definition is specified, the current date is taken. Optional time values that are not specified are set to zero. The timestamp is 24 hours based. For example, TS('16:04') is the same as TS('2002-12-24T16:04:00') provided that the current date is December 24th, 2002.
    If a date part of a TS definition is specified, the year must consist of 4 letters; the month and day specifications are optional. Missing month and day specifications are set to 01. For example, specifying TS('2003') is the same as specifying TS('2003-01-01T00:00:00').
  • Specify binary constants as BIN('UTF-8 string').
  • Use constants instead of integer enumerations. For example, instead of specifying a task instance state expression "TASK.STATE=2" , specify "TASK.STATE=TASK.STATE.STATE_READY".
  • Duplicate apostrophes (') in comparising values. For example, "TASK_CPROP.STRING_VALUE='d''automatisation'".
  • To specify a where clause that refers to properties of name-value pairs, like custom properties, add a one-digit suffix (0-9) to the view name.
    For example, to have only tuples returned where a task custom property "prop1" has the value "v1" or where a task custom property "prop2" has the value v2", the where clause can look like "TASK_CPROP1.NAME='prop1' AND TASK_CPROP1.STRING_VALUE='v1' OR TASK_CPROP2.NAME='prop2' AND TASK_CPROP2.STRING_VALUE = 'v2'". For performance reasons, you should not use more than one "OR" construct; use "IN" instead.
    For example, to retrieve the values of custom properties "prop1" and "prop2" of all task instances, the select clause can look like "DISTINCT TASK.TKIID, TASK_CPROP1.STRING_VALUE, TASK_CPROP2.STRING_VALUE" and the where-clause "TASK_CPROP1.NAME = 'prop1' AND TASK_CPROP2.NAME = 'prop2'".

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

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

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

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

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

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

threshold - The maximum number of stored query execution result tuples to be returned from the server to the client. If a threshold is not to be applied, null must be specified.
timeZone - Specifies the time zone of the timestamp constants in the whereClause. If a timezone is not specified, UTC is assumed.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

InvalidLengthException
NotAuthorizedException
ParameterNullException
StoredQueryNameNotUniqueException
UnexpectedFailureException
Since:
6.0

createTask

public TKIID createTask(java.lang.String name,
                        java.lang.String namespace)
                 throws ApplicationVetoException,
                        CannotCreateWorkItemException,
                        InvalidApplicationStateException,
                        InvalidLengthException,
                        NotAuthorizedException,
                        ObjectDoesNotExistException,
                        ParameterNullException,
                        WrongKindException,
                        WrongStateException,
                        UnexpectedFailureException,
                        CommunicationException
Creates a task instance.

The caller must be a potential instance creator or an administrator of the task template.

Parameters:
name - The name of the task template from which an instance is to be created.
namespace - The namespace of the task template.

Returns:
TKIID - The object ID of the task instance created.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
CannotCreateWorkItemException
InvalidApplicationStateException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

createTask

public TKIID createTask(java.lang.String name,
                        java.lang.String namespace,
                        ClientObjectWrapper input)
                 throws ApplicationVetoException,
                        CannotCreateWorkItemException,
                        InvalidApplicationStateException,
                        InvalidLengthException,
                        NotAuthorizedException,
                        ObjectDoesNotExistException,
                        ParameterNullException,
                        WrongKindException,
                        WrongStateException,
                        UnexpectedFailureException,
                        CommunicationException
Creates a task instance and specifies an input message.

The caller must be a potential instance creator or an administrator of the task template.

Parameters:
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.

Returns:
TKIID - The object ID of the task instance created.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
CannotCreateWorkItemException
InvalidApplicationStateException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

createTask

public 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
Creates a task instance from the specified task model.

The caller must have potential-instance-creator rights on the associated application component.

Parameters:
taskModel - The model that describes the task instance to be created on-the-fly.
applicationName - The name of the enterprise application that contains the message definitions. If the message definitions are simple types only, null may be specified.
parentContext - The object ID (ACOID) or the name of the application component to be associated with the task instance.

Returns:
TKIID - The object ID of the task instance created.
Throws:
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
Since:
6.0.1

createTask

public 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
Creates a task instance from the specified task model and specifies an input message.

The caller must have potential-instance-creator rights on the associated application component.

Parameters:
taskModel - The model that describes the task instance to be created on-the-fly.
applicationName - The name of the enterprise application that contains the message definitions. If the message definitions are simple types only, 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.

Returns:
TKIID - The object ID of the task instance created.
Throws:
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
Since:
6.0.1

createTaskTemplate

public 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
Creates a task template from the specified task model.

The caller must have potential-instance-creator rights on the associated application component.

Parameters:
taskModel - The model that describes the task template to be created on-the-fly.
applicationName - The name of the enterprise application that contains the message definitions. If the message definitions are simple types only, null may be specified.

Returns:
TKTID - The task template ID of the task template created.
Throws:
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
Since:
6.0.1

createWorkItem

public void createWorkItem(java.lang.String tkiid,
                           int assignmentReason,
                           java.lang.String userID)
                    throws ApplicationVetoException,
                           EverybodyWorkItemException,
                           IdWrongFormatException,
                           IdWrongTypeException,
                           InvalidAssignmentReasonException,
                           InvalidLengthException,
                           NotAuthorizedException,
                           ObjectDoesNotExistException,
                           ParameterNullException,
                           TaskDelegationNotSupportedException,
                           WorkItemManagerException,
                           WrongKindException,
                           WrongStateException,
                           UnexpectedFailureException,
                           CommunicationException
Creates a work item for the specified task instance using a string representation of the task instance ID. The work item is created with the specified assignment reason for the specified user.

The caller must be an administrator when the task is no longer inactive. 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:

Parameters:
tkiid - A string representation of the task instance ID that is used to identify the object the new work item should belong to.
assignmentReason - The reason why the work item is assigned - refer to getAssignmentReason for valid values.
userID - The user the work item should belong to. It is not checked whether the user exists.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
EverybodyWorkItemException
IdWrongFormatException
IdWrongTypeException
InvalidAssignmentReasonException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
TaskDelegationNotSupportedException
WorkItemManagerException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0 - introduced in 5.1.1

createWorkItem

public void createWorkItem(TKIID tkiid,
                           int assignmentReason,
                           java.lang.String userID)
                    throws ApplicationVetoException,
                           EverybodyWorkItemException,
                           IdWrongFormatException,
                           InvalidAssignmentReasonException,
                           InvalidLengthException,
                           NotAuthorizedException,
                           ObjectDoesNotExistException,
                           ParameterNullException,
                           TaskDelegationNotSupportedException,
                           WorkItemManagerException,
                           WrongKindException,
                           WrongStateException,
                           UnexpectedFailureException,
                           CommunicationException
Creates a work item for the specified task instance using the task instance ID. The work item is created with the specified assignment reason for the specified user.

The caller must be an administrator when the task is no longer inactive. 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:

Parameters:
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 getAssignmentReason for valid values.
userID - The user the work item should belong to. It is not checked whether the user exists.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
EverybodyWorkItemException
IdWrongFormatException
InvalidAssignmentReasonException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
TaskDelegationNotSupportedException
WorkItemManagerException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0 - introduced in 5.1.1

delete

public void delete(java.lang.String identifier)
            throws ApplicationVetoException,
                   ChildTaskInstanceActiveException,
                   IdWrongFormatException,
                   IdWrongTypeException,
                   IsNotTopLevelTaskException,
                   NotAuthorizedException,
                   WrongKindException,
                   WrongStateException,
                   UnexpectedFailureException,
                   CommunicationException
Deletes the specified task instance using a string representation of the task instance ID. A participating, human, or administrative task must not be inline.

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.

Parameters:
identifier - A string representation of the task instance ID that is used to identify the task instance.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
ChildTaskInstanceActiveException
IdWrongFormatException
IdWrongTypeException
IsNotTopLevelTaskException
NotAuthorizedException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

delete

public void delete(TKIID tkiid)
            throws ApplicationVetoException,
                   IdWrongFormatException,
                   IsNotTopLevelTaskException,
                   NotAuthorizedException,
                   WrongKindException,
                   WrongStateException,
                   UnexpectedFailureException,
                   CommunicationException
Deletes the specified task instance using the task instance ID. A participating, human, or administrative task must not be inline.

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.

Parameters:
tkiid - The task instance ID that is used to identify the task instance.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
IsNotTopLevelTaskException
NotAuthorizedException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

delete

public void delete(java.lang.String identifier,
                   boolean deleteInstances)
            throws ApplicationVetoException,
                   ChildTaskInstanceActiveException,
                   IdWrongFormatException,
                   IdWrongTypeException,
                   IsNotAdHocException,
                   NotAuthorizedException,
                   ObjectDoesNotExistException,
                   RunningInstancesException,
                   WrongKindException,
                   WrongStateException,
                   UnexpectedFailureException,
                   CommunicationException
Deletes the specified task template using a string representation of the task template ID. The task template must have been created on-the-fly. Templates that have been installed as part of an enterprise application are deleted (uninstalled) together with the enterprise application.

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.

Parameters:
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.
Throws:
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
Since:
6.0.1

delete

public void delete(TKTID tktid,
                   boolean deleteInstances)
            throws ApplicationVetoException,
                   ChildTaskInstanceActiveException,
                   IdWrongFormatException,
                   IsNotAdHocException,
                   NotAuthorizedException,
                   ObjectDoesNotExistException,
                   RunningInstancesException,
                   WrongKindException,
                   WrongStateException,
                   UnexpectedFailureException,
                   CommunicationException
Deletes the specified task template using the task template ID. The task template must have been created on-the-fly. Templates that have been installed as part of an enterprise application are deleted (uninstalled) together with the enterprise application.

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.

Parameters:
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.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
ChildTaskInstanceActiveException
IdWrongFormatException
IsNotAdHocException
NotAuthorizedException
ObjectDoesNotExistException
RunningInstancesException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0.1

deleteStoredQuery

public void deleteStoredQuery(java.lang.String storedQueryName)
                       throws NotAuthorizedException,
                              ParameterNullException,
                              UnexpectedFailureException,
                              CommunicationException
Deletes the specified stored query. Only a task system administrator or a business process administrator can delete a stored query. No error is signalled when the specified stored query does no longer exist.

Refer to createStoredQuery for the creation of stored queries.

Parameters:
storedQueryName - The name of the stored query to be deleted - refer to getStoredQueryNames for the retrieval of existing stored query names.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

NotAuthorizedException
ParameterNullException
UnexpectedFailureException
Since:
6.0

deleteWorkItem

public void deleteWorkItem(java.lang.String tkiid,
                           int assignmentReason,
                           java.lang.String userID)
                    throws ApplicationVetoException,
                           EverybodyWorkItemException,
                           IdWrongFormatException,
                           IdWrongTypeException,
                           InvalidAssignmentReasonException,
                           InvalidLengthException,
                           LastAdminWorkItemException,
                           NotAuthorizedException,
                           WorkItemDoesNotExistException,
                           ObjectDoesNotExistException,
                           ParameterNullException,
                           TaskDelegationNotSupportedException,
                           WorkItemManagerException,
                           WrongKindException,
                           WrongStateException,
                           UnexpectedFailureException,
                           CommunicationException
Deletes the specified work item using a string representation of the task instance ID.

The caller must be an administrator when the task is no longer inactive. 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:

Parameters:
tkiid - A string representation of the task instance ID that is used to identify the work item to be deleted.
assignmentReason - The reason why the work item is assigned - refer to getAssignmentReason for valid values.
userID - The user the work item belongs to.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
EverybodyWorkItemException
IdWrongFormatException
IdWrongTypeException
InvalidAssignmentReasonException
InvalidLengthException
LastAdminWorkItemException
NotAuthorizedException
WorkItemDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
TaskDelegationNotSupportedException
WorkItemManagerException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0 - introduced in 5.1.1

deleteWorkItem

public void deleteWorkItem(TKIID tkiid,
                           int assignmentReason,
                           java.lang.String userID)
                    throws ApplicationVetoException,
                           EverybodyWorkItemException,
                           IdWrongFormatException,
                           InvalidAssignmentReasonException,
                           InvalidLengthException,
                           LastAdminWorkItemException,
                           NotAuthorizedException,
                           WorkItemDoesNotExistException,
                           ObjectDoesNotExistException,
                           ParameterNullException,
                           TaskDelegationNotSupportedException,
                           WorkItemManagerException,
                           WrongKindException,
                           WrongStateException,
                           UnexpectedFailureException,
                           CommunicationException
Deletes the specified work item using the task instance ID.

The caller must be an administrator when the task is no longer inactive. 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:

Parameters:
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 getAssignmentReason for valid values.
userID - The user the work item belongs to.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
EverybodyWorkItemException
IdWrongFormatException
InvalidAssignmentReasonException
InvalidLengthException
LastAdminWorkItemException
NotAuthorizedException
WorkItemDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
TaskDelegationNotSupportedException
WorkItemManagerException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0 - introduced in 5.1.1

getAvailableActions

public int[] getAvailableActions(java.lang.String tkiid)
                          throws IdWrongFormatException,
                                 IdWrongTypeException,
                                 NotAuthorizedException,
                                 ObjectDoesNotExistException,
                                 UnexpectedFailureException,
                                 CommunicationException
Returns the actions that can be called in the current task instance state by the logged-on user using a string representation of the task instance ID. Refer to TaskActions for possible actions.

Parameters:
tkiid - The string representation of the task instance ID.

Returns:
int[] - The set of possible actions. Returns null if there are no available actions.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1.1

getAvailableActions

public int[] getAvailableActions(TKIID tkiid)
                          throws IdWrongFormatException,
                                 NotAuthorizedException,
                                 ObjectDoesNotExistException,
                                 UnexpectedFailureException,
                                 CommunicationException
Returns the actions that can be called in the current task instance state by the logged-on user using the task instance ID. Refer to TaskActions for possible actions.

Parameters:
tkiid - The object ID of the task instance.

Returns:
int[] - The set of possible actions. Returns null if there are no available actions.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1.1

getAvailableActionFlags

public boolean[][] getAvailableActionFlags(java.lang.String[] tkiids)
                                    throws IdWrongFormatException,
                                           IdWrongTypeException,
                                           NotAuthorizedException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException,
                                           CommunicationException
Returns the actions that can be called for the specified tasks in their current state by the logged-on user using string representations of the task instance IDs. Refer to TaskActions for possible actions.

Parameters:
tkiids - An array of string representations of task instance IDs.

Returns:
boolean[][] - An array of actions that can be called for each specified task instance. The array contains a row per task instance and a column per possible action. An array entry thus indicates whether a possible action can be called for the task instance by the logged-on user in the current task instance state. True states that the action can be called. False states that the action cannot be called.

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.

Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getAvailableActionFlags

public boolean[][] getAvailableActionFlags(TKIID[] tkiids)
                                    throws IdWrongFormatException,
                                           NotAuthorizedException,
                                           ObjectDoesNotExistException,
                                           UnexpectedFailureException,
                                           CommunicationException
Returns the actions that can be called for the specified tasks in their current state by the logged-on user using task instance IDs. Refer to TaskActions for possible actions.

Parameters:
tkiids - An array of task instance IDs.

Returns:
boolean[][] - An array of actions that can be called for each specified task instance. The array contains a row per task instance and a column per possible action. An array entry thus indicates whether a possible action can be called for the task instance by the logged-on user in the current task instance state. True states that the action can be called. False states that the action cannot be called.

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.

Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getApplicationComponent

public ApplicationComponent getApplicationComponent(java.lang.String acoid)
                                             throws IdWrongFormatException,
                                                    IdWrongTypeException,
                                                    NotAuthorizedException,
                                                    ObjectDoesNotExistException,
                                                    UnexpectedFailureException,
                                                    CommunicationException
Retrieves the specified application component using a string representation of the application component ID.

The caller must be the task system administrator or the task system monitor.

Parameters:
acoid - A string representation of the application component ID. This is used to identify the application component to be retrieved.

Returns:
ApplicationComponent - The application component. Refer to ApplicationComponent to view the application component properties.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getApplicationComponent

public ApplicationComponent getApplicationComponent(ACOID acoid)
                                             throws IdWrongFormatException,
                                                    NotAuthorizedException,
                                                    ObjectDoesNotExistException,
                                                    UnexpectedFailureException,
                                                    CommunicationException
Retrieves the specified application component using the application component ID.

The caller must be the task system administrator or the task system monitor.

Parameters:
acoid - The object ID of the application component to be retrieved.

Returns:
ApplicationComponent - The application component. Refer to ApplicationComponent to view the application component properties.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getCustomProperty

public java.lang.String getCustomProperty(java.lang.String tkiid,
                                          java.lang.String propertyName)
                                   throws IdWrongFormatException,
                                          IdWrongTypeException,
                                          NotAuthorizedException,
                                          ObjectDoesNotExistException,
                                          ParameterNullException,
                                          WrongKindException,
                                          WrongStateException,
                                          UnexpectedFailureException,
                                          CommunicationException
Retrieves the named custom property of the specified task instance using a string representation of the object ID.

Custom properties allow a user to add additional properties to tasks beyond those provided and managed by the task manager.

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

Parameters:
tkiid - A string representation of the task instance ID. This string is used to identify the object for which the custom property is to be retrieved.
propertyName - The name of the custom property for which the value is to be retrieved.

Returns:
String - The value of the specified custom property. Returns null when the specified property cannot be found.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
5.1.1

getCustomProperty

public java.lang.String getCustomProperty(TKIID tkiid,
                                          java.lang.String propertyName)
                                   throws IdWrongFormatException,
                                          NotAuthorizedException,
                                          ObjectDoesNotExistException,
                                          ParameterNullException,
                                          WrongKindException,
                                          WrongStateException,
                                          UnexpectedFailureException,
                                          CommunicationException
Retrieves the named custom property of the specified task instance using the task instance ID.

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.

Parameters:
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.

Returns:
String - The value of the specified custom property. Returns null when the specified property cannot be found.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
5.1.1

getCustomPropertyNames

public java.util.List getCustomPropertyNames(java.lang.String tkiid)
                                      throws IdWrongFormatException,
                                             IdWrongTypeException,
                                             NotAuthorizedException,
                                             ObjectDoesNotExistException,
                                             UnexpectedFailureException,
                                             CommunicationException
Retrieves the names of all custom properties of the specified task instance using a string representation of the object ID.

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.

Parameters:
tkiid - A string representation of the task instance ID. This string is used to identify the task for which the custom property names are to be retrieved.

Returns:
List - A list of custom property names. Returns an empty list when there are no custom properties.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getCustomPropertyNames

public java.util.List getCustomPropertyNames(TKIID tkiid)
                                      throws NotAuthorizedException,
                                             IdWrongFormatException,
                                             ObjectDoesNotExistException,
                                             UnexpectedFailureException,
                                             CommunicationException
Retrieves the names of all custom properties of the specified task instance using the task instance ID.

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.

Parameters:
tkiid - The task instance ID whose custom property names are to be retrieved.

Returns:
List - A list of custom property names. Returns an empty list when there are no custom properties.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

NotAuthorizedException
IdWrongFormatException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getCustomProperties

public java.util.List getCustomProperties(java.lang.String tkiid)
                                   throws IdWrongFormatException,
                                          IdWrongTypeException,
                                          NotAuthorizedException,
                                          ObjectDoesNotExistException,
                                          UnexpectedFailureException,
                                          CommunicationException
Retrieves all custom properties of the specified task instance using a string representation of the task instance ID.

Custom properties allow a user to add additional properties to tasks 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.

Parameters:
tkiid - A string representation of the task instance ID. This string is used to identify the task for which the custom properties are to be retrieved.

Returns:
List - A list of CustomProperty objects containing the name and value pairs. Returns an empty list when there are no custom properties.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getCustomProperties

public java.util.List getCustomProperties(TKIID tkiid)
                                   throws IdWrongFormatException,
                                          NotAuthorizedException,
                                          ObjectDoesNotExistException,
                                          UnexpectedFailureException,
                                          CommunicationException
Retrieves all custom properties of the specified task instance using the task instance ID.

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.

Parameters:
tkiid - The task instance ID whose custom properties are to be retrieved.

Returns:
List - A list of CustomProperty objects containing the name and value pairs. Returns an empty list when there are no custom properties.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getDocumentation

public java.lang.String getDocumentation(java.lang.String identifier,
                                         java.util.Locale locale)
                                  throws IdWrongFormatException,
                                         IdWrongTypeException,
                                         NotAuthorizedException,
                                         ObjectDoesNotExistException,
                                         UnexpectedFailureException,
                                         CommunicationException
Retrieves the documentation of the specified object using a string representation of the object ID.

Documentations can be retrieved in any state of the object. The caller must have at least reader authority for the object.

Parameters:
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.

Returns:
String - The documentation. Returns null when there is no documentation in the specified locale.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getDocumentation

public java.lang.String getDocumentation(ESIID esiid,
                                         java.util.Locale locale)
                                  throws IdWrongFormatException,
                                         NotAuthorizedException,
                                         ObjectDoesNotExistException,
                                         UnexpectedFailureException,
                                         CommunicationException
Retrieves the documentation of the specified escalation instance using the escalation instance ID.

Documentations can be retrieved in any state of the escalation. The caller must have at least reader authority for the escalation.

Parameters:
esiid - The escalation instance ID that is used to identify the escalation instance.
locale - The locale for which the documentation is to be provided.

Returns:
String - The documentation. Returns null when there is no documentation in the specified locale.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getDocumentation

public java.lang.String getDocumentation(ESTID estid,
                                         java.util.Locale locale)
                                  throws IdWrongFormatException,
                                         NotAuthorizedException,
                                         ObjectDoesNotExistException,
                                         UnexpectedFailureException,
                                         CommunicationException
Retrieves the documentation of the specified escalation template using the escalation template ID.

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

Parameters:
estid - The escalation template ID that is used to identify the escalation template.
locale - The locale for which the documentation is to be provided.

Returns:
String - The documentation. Returns null when there is no documentation in the specified locale.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getDocumentation

public java.lang.String getDocumentation(TKIID tkiid,
                                         java.util.Locale locale)
                                  throws IdWrongFormatException,
                                         NotAuthorizedException,
                                         ObjectDoesNotExistException,
                                         UnexpectedFailureException,
                                         CommunicationException
Retrieves the documentation of the specified task instance using the task instance ID.

Documentations can be retrieved in any state of the task instance. The caller must have at least reader authority for the task instance.

Parameters:
tkiid - The task instance ID that is used to identify the task instance.
locale - The locale for which the documentation is to be provided.

Returns:
String - The documentation. Returns null when there is no documentation in the specified locale.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getDocumentation

public java.lang.String getDocumentation(TKTID tktid,
                                         java.util.Locale locale)
                                  throws IdWrongFormatException,
                                         NotAuthorizedException,
                                         ObjectDoesNotExistException,
                                         UnexpectedFailureException,
                                         CommunicationException
Retrieves the documentation of the specified task template using the task template ID.

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

Parameters:
tktid - The task template ID that is used to identify the task template.
locale - The locale for which the documentation is to be provided.

Returns:
String - The documentation. Returns null when there is no documentation in the specified locale.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getEscalation

public Escalation getEscalation(java.lang.String esiid)
                         throws IdWrongFormatException,
                                IdWrongTypeException,
                                NotAuthorizedException,
                                ObjectDoesNotExistException,
                                UnexpectedFailureException,
                                CommunicationException
Retrieves the specified escalation instance using a string representation of the escalation instance ID.

Escalations can be retrieved in any escalation state. The caller must have at least reader authority.

Parameters:
esiid - A string representation of the escalation instance ID that is used to identify the escalation to be retrieved.

Returns:
Escalation - The escalation instance. Refer to Escalation to view the escalation properties.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getEscalation

public Escalation getEscalation(ESIID esiid)
                         throws IdWrongFormatException,
                                NotAuthorizedException,
                                ObjectDoesNotExistException,
                                UnexpectedFailureException,
                                CommunicationException
Retrieves the specified escalation instance using the escalation instance ID.

Escalations can be retrieved in any escalation state. The caller must have at least reader authority.

Parameters:
esiid - The escalation instance ID that is used to identify the escalation to be retrieved.

Returns:
Escalation - The escalation instance. Refer to Escalation to view the escalation properties.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getEscalationTemplate

public EscalationTemplate getEscalationTemplate(java.lang.String estid)
                                         throws IdWrongFormatException,
                                                IdWrongTypeException,
                                                NotAuthorizedException,
                                                ObjectDoesNotExistException,
                                                UnexpectedFailureException,
                                                CommunicationException
Retrieves the specified escalation template using a string representation of the escalation template ID.

The caller must have at least reader authority.

Parameters:
estid - A string representation of the escalation template ID that is used to identify the escalation template to be retrieved.

Returns:
EscalationTemplate - The escalation template. Refer to EscalationTemplate to view the escalation template properties.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getEscalationTemplate

public EscalationTemplate getEscalationTemplate(ESTID estid)
                                         throws IdWrongFormatException,
                                                NotAuthorizedException,
                                                ObjectDoesNotExistException,
                                                UnexpectedFailureException,
                                                CommunicationException
Retrieves the specified escalation template using the escalation template ID.

The caller must have at least reader authority.

Parameters:
estid - The escalation template ID that is used to identify the escalation template to be retrieved.

Returns:
EscalationTemplate - The escalation template. Refer to EscalationTemplate to view the escalation template properties.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getFaultMessage

public ClientObjectWrapper getFaultMessage(java.lang.String tkiid)
                                    throws DataHandlingException,
                                           IdWrongFormatException,
                                           IdWrongTypeException,
                                           NotAuthorizedException,
                                           ObjectDoesNotExistException,
                                           WrongKindException,
                                           WrongStateException,
                                           UnexpectedFailureException,
                                           CommunicationException
Retrieves the fault message of the specified task instance using a string representation of the task instance ID.

The task instance can be in any state but inactive. The caller must have at least reader authority for the task instance.

Parameters:
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.

Returns:
ClientObjectWrapper - The fault message. If there is no fault message, an empty client object wrapper is returned.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

DataHandlingException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
5.1.1

getFaultMessage

public ClientObjectWrapper getFaultMessage(TKIID tkiid)
                                    throws DataHandlingException,
                                           IdWrongFormatException,
                                           NotAuthorizedException,
                                           ObjectDoesNotExistException,
                                           WrongKindException,
                                           WrongStateException,
                                           UnexpectedFailureException,
                                           CommunicationException
Retrieves the fault message of the specified task instance using the task instance ID.

The task instance can be in any state but inactive. The caller must have at least reader authority for the task instance.

Parameters:
tkiid - The object ID of the task instance for which the fault message is to be retrieved.

Returns:
ClientObjectWrapper - The fault message. If there is no fault message, an empty client object wrapper is returned.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

DataHandlingException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
5.1.1

getFaultNames

public java.util.List getFaultNames(java.lang.String tkiid)
                             throws IdWrongFormatException,
                                    IdWrongTypeException,
                                    NotAuthorizedException,
                                    ObjectDoesNotExistException,
                                    WrongKindException,
                                    WrongStateException,
                                    UnexpectedFailureException,
                                    CommunicationException
Retrieves the fault names defined for the specified task instance using a string representation of the task instance ID.

The task instance must be a participating or human task. It can be in any state. The caller must have at least reader authority for the task instance.

Parameters:
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.

Returns:
List - A list of fault names. If there are no faults, an empty list is returned. Fault names are to be specified when a fault message is set. Refer to complete, setFaultMessage, or to createFaultMessage.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
5.1.1

getFaultNames

public java.util.List getFaultNames(TKIID tkiid)
                             throws IdWrongFormatException,
                                    NotAuthorizedException,
                                    ObjectDoesNotExistException,
                                    WrongKindException,
                                    WrongStateException,
                                    UnexpectedFailureException,
                                    CommunicationException
Retrieves the fault names defined for the specified task instance using the task instance ID.

The task instance must be a participating or human task. It can be in any state. The caller must have at least reader authority for the task instance.

Parameters:
tkiid - The object ID of the task instance for which the fault names are to be retrieved.

Returns:
List - A list of fault names. If there are no faults, an empty list is returned. Fault names are to be specified when a fault message is set. Refer to complete, setFaultMessage, or to createFaultMessage.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
5.1.1

getInputMessage

public ClientObjectWrapper getInputMessage(java.lang.String tkiid)
                                    throws DataHandlingException,
                                           IdWrongFormatException,
                                           IdWrongTypeException,
                                           NotAuthorizedException,
                                           ObjectDoesNotExistException,
                                           WrongKindException,
                                           WrongStateException,
                                           UnexpectedFailureException,
                                           CommunicationException
Retrieves the input message of the specified task instance using a string representation of the task instance ID.

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.

Parameters:
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.

Returns:
ClientObjectWrapper - The input message. Returns an empty client object wrapper when there is no input message.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

DataHandlingException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
5.1.1

getInputMessage

public ClientObjectWrapper getInputMessage(TKIID tkiid)
                                    throws DataHandlingException,
                                           IdWrongFormatException,
                                           NotAuthorizedException,
                                           ObjectDoesNotExistException,
                                           WrongKindException,
                                           WrongStateException,
                                           UnexpectedFailureException,
                                           CommunicationException
Retrieves the input message of the task instance using the task instance ID.

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.

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

Returns:
ClientObjectWrapper - The input message. Returns an empty client object wrapper when there is no input message.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

DataHandlingException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
5.1.1

getOutputMessage

public ClientObjectWrapper getOutputMessage(java.lang.String tkiid)
                                     throws DataHandlingException,
                                            IdWrongFormatException,
                                            IdWrongTypeException,
                                            NotAuthorizedException,
                                            ObjectDoesNotExistException,
                                            WrongKindException,
                                            WrongStateException,
                                            UnexpectedFailureException,
                                            CommunicationException
Retrieves the output message of the specified task instance using a string representation of the ID.

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.

Parameters:
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.

Returns:
ClientObjectWrapper - The output message. If the output message has not yet been set, an empty client object wrapper is returned.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

DataHandlingException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
5.1.1

getOutputMessage

public ClientObjectWrapper getOutputMessage(TKIID tkiid)
                                     throws DataHandlingException,
                                            IdWrongFormatException,
                                            NotAuthorizedException,
                                            ObjectDoesNotExistException,
                                            WrongKindException,
                                            WrongStateException,
                                            UnexpectedFailureException,
                                            CommunicationException
Retrieves the output message of the specified task instance using the task instance ID.

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.

Parameters:
tkiid - The object ID of the task instance whose output message is to be retrieved.

Returns:
ClientObjectWrapper - The output message. If the output message has not yet been set, an empty client object wrapper is returned.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

DataHandlingException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
5.1.1

getStoredQuery

public StoredQuery getStoredQuery(java.lang.String storedQueryName)
                           throws ObjectDoesNotExistException,
                                  ParameterNullException,
                                  UnexpectedFailureException,
                                  CommunicationException
Retrieves the specified stored query definition.

Parameters:
storedQueryName - The name of the stored query to be retrieved - refer to getStoredQueryNames for the retrieval of existing stored query names.

Returns:
StoredQuery - StoredQuery - The definition of the stored query retrieved - refer to StoredQuery to view the stored query definition. If the specified stored query is not found, a null object is returned.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ObjectDoesNotExistException
ParameterNullException
UnexpectedFailureException
Since:
6.0

getStoredQueryNames

public java.lang.String[] getStoredQueryNames()
                                       throws WorkItemManagerException,
                                              UnexpectedFailureException,
                                              CommunicationException
Retrieves the names of stored queries that are persistently stored in the database. Refer to createStoredQuery for the creation of stored queries.

Returns:
String[] - String[] - An array of stored query names. If there are no stored queries, an empty array is returned.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

WorkItemManagerException
UnexpectedFailureException
Since:
6.0

getTask

public Task getTask(java.lang.String tkiid)
             throws IdWrongFormatException,
                    IdWrongTypeException,
                    NotAuthorizedException,
                    ObjectDoesNotExistException,
                    UnexpectedFailureException,
                    CommunicationException
Retrieves the specified task instance using a string representation of the task instance ID.

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

Parameters:
tkiid - A string representation of the task instance ID. This is used to identify the task instance to be retrieved.

Returns:
Task - The task instance. Refer to Task to view the task instance properties.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1.1

getTask

public Task getTask(TKIID tkiid)
             throws IdWrongFormatException,
                    NotAuthorizedException,
                    ObjectDoesNotExistException,
                    UnexpectedFailureException,
                    CommunicationException
Retrieves the specified task instance using the task instance ID.

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

Parameters:
tkiid - The object ID of the task instance to be retrieved.

Returns:
Task - The task instance. Refer to Task to view the task instance properties.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
5.1.1

getTaskTemplate

public TaskTemplate getTaskTemplate(java.lang.String tktid)
                             throws IdWrongFormatException,
                                    IdWrongTypeException,
                                    NotAuthorizedException,
                                    ObjectDoesNotExistException,
                                    UnexpectedFailureException,
                                    CommunicationException
Retrieves the specified task template using a string representation of the task template ID.

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

Parameters:
tktid - A string representation of the object ID of the task template to be retrieved.

Returns:
TaskTemplate - The task template. Refer to TaskTemplate to view the task template properties.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getTaskTemplate

public TaskTemplate getTaskTemplate(TKTID tktid)
                             throws IdWrongFormatException,
                                    NotAuthorizedException,
                                    ObjectDoesNotExistException,
                                    UnexpectedFailureException,
                                    CommunicationException
Retrieves the specified task template using the task template ID.

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

Parameters:
tktid - The object ID of the task template to be retrieved.

Returns:
TaskTemplate - The task template. Refer to TaskTemplate to view the task template properties.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
Since:
6.0

getUISettings

public CustomClientSettings getUISettings(java.lang.String identifier)
                                   throws IdWrongFormatException,
                                          IdWrongTypeException,
                                          NotAuthorizedException,
                                          ObjectDoesNotExistException,
                                          WrongKindException,
                                          UnexpectedFailureException,
                                          CommunicationException
Retrieves client interface settings for the specified task instance or template using a string representation of the object ID.

Client interface settings allow for the specification of presentations that can be used by the caller to present objects and data to an end user.

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.

Parameters:
identifier - A string representation of the task instance or template ID.

Returns:
CustomClientSettings - The customized client interface settings. Returns null when there are no client interface settings.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
UnexpectedFailureException
Since:
5.1.1

getUISettings

public CustomClientSettings getUISettings(TKTID tktid)
                                   throws IdWrongFormatException,
                                          NotAuthorizedException,
                                          ObjectDoesNotExistException,
                                          UnexpectedFailureException,
                                          WrongKindException,
                                          CommunicationException
Retrieves client interface settings for the specified task template using the task template ID.

Client interface settings allow for the specification of presentations that can be used by the caller to present objects and data to an end user.

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

Parameters:
tktid - The object ID of the task template.

Returns:
CustomClientSettings - The customized client interface settings. Returns null when there are no client interface settings.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
WrongKindException
Since:
6.0

getUISettings

public CustomClientSettings getUISettings(TKIID tkiid)
                                   throws IdWrongFormatException,
                                          NotAuthorizedException,
                                          ObjectDoesNotExistException,
                                          UnexpectedFailureException,
                                          WrongKindException,
                                          CommunicationException
Retrieves client interface settings for the specified task instance using the task instance ID.

Client interface settings allow for the specification of presentations that can be used by the caller to present objects and data to an end user.

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.

Parameters:
tkiid - The object ID of the task instance.

Returns:
CustomClientSettings - The customized client interface settings. Returns null when there are no client interface settings.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
UnexpectedFailureException
WrongKindException
Since:
5.1.1

getUsersInRole

public StaffResultSet getUsersInRole(java.lang.String tkiid,
                                     int role)
                              throws IdWrongFormatException,
                                     IdWrongTypeException,
                                     InvalidAssignmentReasonException,
                                     NotAuthorizedException,
                                     ObjectDoesNotExistException,
                                     WorkItemManagerException,
                                     UnexpectedFailureException,
                                     CommunicationException
Retrieves the users that are members of the specified role for the specified task using a string representation of the task instance ID.

Parameters:
tkiid - A string representation of task instance ID that is used to identify the task instance.
role - The role whose members are to be queried.

Returns:
StaffResultSet - The users that are members of the specified role. Refer to StaffResultSet for more information.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
InvalidAssignmentReasonException
NotAuthorizedException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
Since:
6.0

getUsersInRole

public StaffResultSet getUsersInRole(TKIID tkiid,
                                     int role)
                              throws IdWrongFormatException,
                                     InvalidAssignmentReasonException,
                                     NotAuthorizedException,
                                     ObjectDoesNotExistException,
                                     WorkItemManagerException,
                                     UnexpectedFailureException,
                                     CommunicationException
Retrieves the users that are members of the specified role for the specified task using the task instance ID.

Parameters:
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.

Returns:
StaffResultSet - The users that are members of the specified role. Refer to StaffResultSet for more information.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
InvalidAssignmentReasonException
NotAuthorizedException
ObjectDoesNotExistException
WorkItemManagerException
UnexpectedFailureException
Since:
6.0

isSystemAdministrator

public boolean isSystemAdministrator()
                              throws CommunicationException
States whether the logged-on user is a system administrator for the human task manager component.

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.

Returns:
boolean - boolean - True states that the logged-on user is a task system administrator. False states that the logged-on user is no task system administrator.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

Since:
6.0

isSystemMonitor

public boolean isSystemMonitor()
                        throws CommunicationException
States whether the logged-on user is a system monitor for the human task manager component.

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 system monitor has the priviledge to read all objects.

Returns:
boolean - boolean - True states that the logged-on user is a task system monitor. False states that the logged-on user is no task system monitor.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

Since:
6.0

isUserInRole

public boolean isUserInRole(java.lang.String tkiid,
                            java.lang.String userID,
                            int role)
                     throws IdWrongFormatException,
                            IdWrongTypeException,
                            InvalidAssignmentReasonException,
                            NotAuthorizedException,
                            ObjectDoesNotExistException,
                            ParameterNullException,
                            WorkItemManagerException,
                            UnexpectedFailureException,
                            CommunicationException
States whether the specified user is a member of the specified role for the specified task instance using a string representation of the task instance ID.

Parameters:
tkiid - A string representation of task instance ID that is used to identify the task instance.
userID - The user who is to be checked.
role - The role that the user needs to be a member of.

Returns:
boolean - boolean - True states that the user is a member of the specified role. False states that the user is no member of the specified role.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
InvalidAssignmentReasonException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WorkItemManagerException
UnexpectedFailureException
Since:
6.0

isUserInRole

public boolean isUserInRole(TKIID tkiid,
                            java.lang.String userID,
                            int role)
                     throws IdWrongFormatException,
                            InvalidAssignmentReasonException,
                            NotAuthorizedException,
                            ObjectDoesNotExistException,
                            ParameterNullException,
                            WorkItemManagerException,
                            UnexpectedFailureException,
                            CommunicationException
States whether the specified user is a member of the specified role for the specified task instance using the task instance ID.

Parameters:
tkiid - The object ID of the task instance that is used to identify the task instance.
userID - The user who is to be checked.
role - The role that the user needs to be a member of.

Returns:
boolean - boolean - True states that the user is a member of the specified role. False states that the user is no member of the specified role.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
InvalidAssignmentReasonException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WorkItemManagerException
UnexpectedFailureException
Since:
6.0

query

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

You can specify a filter or a threshold to restrict the number of tuples returned. The tuples are sorted on the server according to the specified sort criteria. This means that the locale of the server is used for sorting.

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.

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

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

Parameters:
selectClause - Describes the query result, that is, declares a list of names that identify the object properties (columns of the result) to be returned. Its syntax is an SQL select-clause. Aggregation functions like AVG(), SUM(), MIN(), and MAX() are not supported. Each comma separated part of the select-clause must specify a property from the published 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:
  • Specify object ID constants as ID('string-rep-of-oid').
  • Specify timestamp constants as TS('yyyy-mm-ddThh:mm:ss') or as CURRENT_DATE for comparisons with the current date.
    The date and time parts of a TS definition are optional; either the date or the time must be specified. If no date part of a TS definition is specified, the current date is taken. Optional time values that are not specified are set to zero. The timestamp is 24 hours based. For example, TS('16:04') is the same as TS('2002-12-24T16:04:00') provided that the current date is December 24th, 2002.
    If a date part of a TS definition is specified, the year must consist of 4 letters; the month and day specifications are optional. Missing month and day specifications are set to 01. For example, specifying TS('2003') is the same as specifying TS('2003-01-01T00:00:00').
  • Specify binary constants as BIN('UTF-8 string').
  • Use constants instead of integer enumerations. For example, instead of specifying a task instance state expression "TASK.STATE=2" , specify "TASK.STATE=TASK.STATE.STATE_READY".
  • Duplicate apostrophes (') in comparising values. For example, "TASK_CPROP.STRING_VALUE='d''automatisation'".
  • To specify a where clause that refers to properties of name-value pairs, like custom properties, add a one-digit suffix (0-9) to the view name.
    For example, to have only tuples returned where a task custom property "prop1" has the value "v1" or where a task custom property "prop2" has the value v2", the where clause can look like "TASK_CPROP1.NAME='prop1' AND TASK_CPROP1.STRING_VALUE='v1' OR TASK_CPROP2.NAME='prop2' AND TASK_CPROP2.STRING_VALUE = 'v2'". For performance reasons, you should not use more than one "OR" construct; use "IN" instead.
    For example, to retrieve the values of custom properties "prop1" and "prop2" of all task instances, the select clause can look like "DISTINCT TASK.TKIID, TASK_CPROP1.STRING_VALUE, TASK_CPROP2.STRING_VALUE" and the where-clause "TASK_CPROP1.NAME = 'prop1' AND TASK_CPROP2.NAME = 'prop2'".

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

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

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

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

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

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

Returns:
QueryResultSet - An object containing the query result. If qualifying tuples are not found, an empty query result set is returned. Refer to QueryResultSet for information on how to analyze the query result set.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ParameterNullException
UnexpectedFailureException
WorkItemManagerException
Since:
5.1.1

query

public QueryResultSet query(java.lang.String selectClause,
                            java.lang.String whereClause,
                            java.lang.String orderByClause,
                            java.lang.Integer skipTuples,
                            java.lang.Integer threshold,
                            java.util.TimeZone timeZone)
                     throws ParameterNullException,
                            UnexpectedFailureException,
                            WorkItemManagerException,
                            CommunicationException
Retrieves selected object properties persistently stored in the database and allows for retrieving a specified set of data only.

You can specify a filter, a starting tuple, or a threshold to restrict the number of tuples returned. The tuples are sorted on the server according to the specified sort criteria. This means that the locale of the server is used for sorting.

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.

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

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

Parameters:
selectClause - Describes the query result, that is, declares a list of names that identify the object properties (columns of the result) to be returned. Its syntax is an SQL select-clause. Aggregation functions like AVG(), SUM(), MIN(), and MAX() are not supported. Each comma separated part of the select-clause must specify a property from the published 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:
  • Specify object ID constants as ID('string-rep-of-oid').
  • Specify timestamp constants as TS('yyyy-mm-ddThh:mm:ss') or as CURRENT_DATE for comparisons with the current date.
    The date and time parts of a TS definition are optional; either the date or the time must be specified. If no date part of a TS definition is specified, the current date is taken. Optional time values that are not specified are set to zero. The timestamp is 24 hours based. For example, TS('16:04') is the same as TS('2002-12-24T16:04:00') provided that the current date is December 24th, 2002.
    If a date part of a TS definition is specified, the year must consist of 4 letters; the month and day specifications are optional. Missing month and day specifications are set to 01. For example, specifying TS('2003') is the same as specifying TS('2003-01-01T00:00:00').
  • Specify binary constants as BIN('UTF-8 string').
  • Use constants instead of integer enumerations. For example, instead of specifying a task instance state expression "TASK.STATE=2" , specify "TASK.STATE=TASK.STATE.STATE_READY".
  • Duplicate apostrophes (') in comparising values. For example, "TASK_CPROP.STRING_VALUE='d''automatisation'".
  • To specify a where clause that refers to properties of name-value pairs, like custom properties, add a one-digit suffix (0-9) to the view name.
    For example, to have only tuples returned where a task custom property "prop1" has the value "v1" or where a task custom property "prop2" has the value v2", the where clause can look like "TASK_CPROP1.NAME='prop1' AND TASK_CPROP1.STRING_VALUE='v1' OR TASK_CPROP2.NAME='prop2' AND TASK_CPROP2.STRING_VALUE = 'v2'". For performance reasons, you should not use more than one "OR" construct; use "IN" instead.
    For example, to retrieve the values of custom properties "prop1" and "prop2" of all task instances, the select clause can look like "DISTINCT TASK.TKIID, TASK_CPROP1.STRING_VALUE, TASK_CPROP2.STRING_VALUE" and the where-clause "TASK_CPROP1.NAME = 'prop1' AND TASK_CPROP2.NAME = 'prop2'".

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

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

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

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

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

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

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

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

Returns:
QueryResultSet - An object containing the query result. If qualifying tuples are not found, an empty query result set is returned. Refer to QueryResultSet for information on how to analyze the query result set.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ParameterNullException
UnexpectedFailureException
WorkItemManagerException
Since:
6.0

query

public QueryResultSet query(java.lang.String storedQueryName,
                            java.lang.Integer skipTuples)
                     throws IdWrongFormatException,
                            ObjectDoesNotExistException,
                            ParameterNullException,
                            QueryInvalidOperandException,
                            QueryInvalidTimestampException,
                            QueryUndefinedParameterException,
                            QueryUnknownColumnException,
                            QueryUnknownOperatorException,
                            QueryUnknownTableException,
                            UnexpectedFailureException,
                            CommunicationException
Calls the specified stored query and returns the qualifying object properties. Only properties of objects are returned for which the logged-on user has a work item. Note that a system administrator or system monitor has special rights and can retrieve all properties of objects for which there is a user's work item.

Refer to createStoredQuery for the creation of stored queries.

Parameters:
storedQueryName - The name of the stored query to be executed - refer to getStoredQueryNames for the retrieval of existing stored query names.
skipTuples - The number of query result set tuples to be ignored and not to be returned to the caller. For example, a value of '5' means that the first 5 qualifying tuples are not returned. Use this parameter together with the threshold 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.

Returns:
QueryResultSet - QueryResultSet - The qualifying object properties. If qualifying objects are not found, an empty query result set is returned. Refer to QueryResultSet for information on how to analyze the query result set.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
ObjectDoesNotExistException
ParameterNullException
QueryInvalidOperandException
QueryInvalidTimestampException
QueryUndefinedParameterException
QueryUnknownColumnException
QueryUnknownOperatorException
QueryUnknownTableException
UnexpectedFailureException
Since:
6.0

query

public QueryResultSet query(java.lang.String storedQueryName,
                            java.lang.Integer skipTuples,
                            java.lang.Integer threshold)
                     throws IdWrongFormatException,
                            ObjectDoesNotExistException,
                            ParameterNullException,
                            QueryInvalidOperandException,
                            QueryInvalidTimestampException,
                            QueryUndefinedParameterException,
                            QueryUnknownColumnException,
                            QueryUnknownOperatorException,
                            QueryUnknownTableException,
                            UnexpectedFailureException,
                            CommunicationException
Calls the specified stored query and returns the properties of objects in the specified range. Only properties of objects are returned for which the logged-on user has a work item. Note that a system administrator or system monitor has special rights and can retrieve all properties of objects for which there is a user's work item.

Refer to createStoredQuery for the creation of stored queries.

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

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

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

Returns:
QueryResultSet - QueryResultSet - The qualifying object properties. If qualifying objects are not found, an empty query result set is returned. Refer to QueryResultSet for information on how to analyze the query result set.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
ObjectDoesNotExistException
ParameterNullException
QueryInvalidOperandException
QueryInvalidTimestampException
QueryUndefinedParameterException
QueryUnknownColumnException
QueryUnknownOperatorException
QueryUnknownTableException
UnexpectedFailureException
Since:
6.0.1

queryAll

public QueryResultSet queryAll(java.lang.String selectClause,
                               java.lang.String whereClause,
                               java.lang.String orderByClause,
                               java.lang.Integer skipTuples,
                               java.lang.Integer threshold,
                               java.util.TimeZone timeZone)
                        throws NotAuthorizedException,
                               ParameterNullException,
                               UnexpectedFailureException,
                               WorkItemManagerException,
                               CommunicationException
Retrieves selected object properties of all objects persistently stored in the database and allows for retrieving a specified set of data only.

You can specify a filter, a starting tuple, or a threshold to restrict the number of tuples returned. The tuples are sorted on the server according to the specified sort criteria. This means that the locale of the server is used for sorting.

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.

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

The caller must be a system administrator or system monitor.

Parameters:
selectClause - Describes the query result, that is, represents a list of names that identify the object properties (columns of the result) to be returned. Its syntax is an SQL select-clause. Aggregation functions like AVG(), SUM(), 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:
  • Specify object ID constants as ID('string-rep-of-oid').
  • Specify timestamp constants as TS('yyyy-mm-ddThh:mm:ss') or as CURRENT_DATE for comparisons with the current date.
    The date and time parts of a TS definition are optional; either the date or the time must be specified. If no date part of a TS definition is specified, the current date is taken. Optional time values that are not specified are set to zero. The timestamp is 24 hours based. For example, TS('16:04') is the same as TS('2002-12-24T16:04:00') provided that the current date is December 24th, 2002.
    If a date part of a TS definition is specified, the year must consist of 4 letters; the month and day specifications are optional. Missing month and day specifications are set to 01. For example, specifying TS('2003') is the same as specifying TS('2003-01-01T00:00:00').
  • Specify binary constants as BIN('UTF-8 string').
  • Use constants instead of integer enumerations. For example, instead of specifying a task instance state expression "TASK.STATE=2" , specify "TASK.STATE=TASK.STATE.STATE_READY".
  • Duplicate apostrophes (') in comparising values. For example, "TASK_CPROP.STRING_VALUE='d''automatisation'".
  • To specify a where clause that refers to properties of name-value pairs, like custom properties, add a one-digit suffix (0-9) to the view name.
    For example, to have only tuples returned where a task custom property "prop1" has the value "v1" or where a task custom property "prop2" has the value v2", the where clause can look like "TASK_CPROP1.NAME='prop1' AND TASK_CPROP1.STRING_VALUE='v1' OR TASK_CPROP2.NAME='prop2' AND TASK_CPROP2.STRING_VALUE = 'v2'". For performance reasons, you should not use more than one "OR" construct; use "IN" instead.
    For example, to retrieve the values of custom properties "prop1" and "prop2" of all task instances, the select clause can look like "DISTINCT TASK.TKIID, TASK_CPROP1.STRING_VALUE, TASK_CPROP2.STRING_VALUE" and the where-clause "TASK_CPROP1.NAME = 'prop1' AND TASK_CPROP2.NAME = 'prop2'".

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

orderByClause - Sorts the query result set by the values of the columns you identify. Its syntax is an SQL order-by-clause. Each comma separated part of the order-by-clause must specify a property from the published 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. If a timezone is not specified, UTC is assumed.

Returns:
QueryResultSet - An object containing the query result. If qualifying tuples are not found, an empty query result set is returned. Refer to QueryResultSet for information on how to analyze the query result set.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

NotAuthorizedException
ParameterNullException
UnexpectedFailureException
WorkItemManagerException
Since:
6.0

queryTaskTemplates

public TaskTemplate[] queryTaskTemplates(java.lang.String whereClause,
                                         java.lang.String orderByClause,
                                         java.lang.Integer threshold,
                                         java.util.TimeZone timeZone)
                                  throws IdWrongFormatException,
                                         QueryInvalidOperandException,
                                         QueryInvalidTimestampException,
                                         QueryUndefinedParameterException,
                                         QueryUnknownColumnException,
                                         QueryUnknownOperatorException,
                                         QueryUnknownTableException,
                                         UnexpectedFailureException,
                                         CommunicationException
Retrieves task templates that are persistently stored in the database and that are part of started applications.

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. This means that the locale of the server is used for sorting.

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.

Parameters:
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:
  • Specify object ID constants as ID('string-rep-of-oid').
  • Specify timestamp constants as TS('yyyy-mm-ddThh:mm:ss') or as CURRENT_DATE for comparisons with the current date.
    The date and time parts of a TS definition are optional; either the date or the time must be specified. If no date part of a TS definition is specified, the current date is taken. Optional time values that are not specified are set to zero. The timestamp is 24 hours based. For example, TS('16:04') is the same as TS('2002-12-24T16:04:00') provided that the current date is December 24th, 2002.
    If a date part of a TS definition is specified, the year must consist of 4 letters; the month and day specifications are optional. Missing month and day specifications are set to 01. For example, specifying TS('2003') is the same as specifying TS('2003-01-01T00:00:00').
  • Specify binary constants as BIN('UTF-8 string').
  • Use constants instead of integer enumerations. For example, instead of specifying a task tempalte state expression "TASK_TEMPL.STATE=2" , specify "TASK_TEMPL.STATE=TASK_TEMPL.STATE.STATE_STOPPED".
  • Duplicate apostrophes (') in comparising values. For example, "TASK_CPROP.STRING_VALUE='d''automatisation'".

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. If a timezone is not specified, UTC is assumed.

Returns:
TaskTemplate[] - An array of qualifying task templates. If no templates qualify, an empty array is returned. Refer to TaskTemplate to view the process template properties.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
QueryInvalidOperandException
QueryInvalidTimestampException
QueryUndefinedParameterException
QueryUnknownColumnException
QueryUnknownOperatorException
QueryUnknownTableException
UnexpectedFailureException
Since:
6.0

resume

public void resume(java.lang.String tkiid)
            throws ApplicationVetoException,
                   IdWrongFormatException,
                   IdWrongTypeException,
                   NotAuthorizedException,
                   ObjectDoesNotExistException,
                   WrongKindException,
                   WrongStateException,
                   UnexpectedFailureException,
                   CommunicationException
Resumes the execution of the specified suspended human or participating task instance using a string representation of the task instance ID.

The suspended task instance can be in the ready or claimed state. It can have been escalated. The caller can be the owner, originator, or administrator of the task instance.

Parameters:
tkiid - A string representation of the task instance ID to be resumed.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

resume

public void resume(TKIID tkiid)
            throws ApplicationVetoException,
                   IdWrongFormatException,
                   NotAuthorizedException,
                   ObjectDoesNotExistException,
                   WrongKindException,
                   WrongStateException,
                   UnexpectedFailureException,
                   CommunicationException
Resumes the execution of the specified suspended human or participating task instance using the task instance ID.

The suspended task instance can be in the ready or claimed state. It can have been escalated. The caller can be the owner, originator, or administrator of the task instance.

Parameters:
tkiid - The object ID of the task instance to be resumed.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

setCustomProperty

public void setCustomProperty(java.lang.String tkiid,
                              java.lang.String propertyName,
                              java.lang.String propertyValue)
                       throws ApplicationVetoException,
                              IdWrongFormatException,
                              IdWrongTypeException,
                              InvalidLengthException,
                              NotAuthorizedException,
                              ObjectDoesNotExistException,
                              ParameterNullException,
                              WrongKindException,
                              UnexpectedFailureException,
                              CommunicationException
Stores custom-specific values for the specified task instance using a string representation of the object ID.

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.

Parameters:
tkiid - A string representation of the task instance ID that is used to identify 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.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
UnexpectedFailureException
Since:
5.1.1

setCustomProperty

public void setCustomProperty(TKIID tkiid,
                              java.lang.String propertyName,
                              java.lang.String propertyValue)
                       throws ApplicationVetoException,
                              IdWrongFormatException,
                              InvalidLengthException,
                              NotAuthorizedException,
                              ObjectDoesNotExistException,
                              ParameterNullException,
                              WrongKindException,
                              UnexpectedFailureException,
                              CommunicationException
Stores custom-specific values for the specified task instance.

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.

Parameters:
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.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
UnexpectedFailureException
Since:
5.1.1

setFaultMessage

public void setFaultMessage(java.lang.String tkiid,
                            java.lang.String faultName,
                            ClientObjectWrapper faultMessage)
                     throws IdWrongFormatException,
                            IdWrongTypeException,
                            InvalidQNameException,
                            NotAuthorizedException,
                            ObjectDoesNotExistException,
                            ParameterNullException,
                            WrongKindException,
                            WrongMessageTypeException,
                            WrongStateException,
                            UnexpectedFailureException,
                            CommunicationException
Stores the specified fault message for the specified task instance into the database using a string representation of the task instance ID. The fault message is saved only, that is, the state of the task instance is not changed. Refer to 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 participating or human task. 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.

Parameters:
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.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
IdWrongTypeException
InvalidQNameException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
Since:
5.1.1

setFaultMessage

public void setFaultMessage(TKIID tkiid,
                            java.lang.String faultName,
                            ClientObjectWrapper faultMessage)
                     throws IdWrongFormatException,
                            InvalidQNameException,
                            NotAuthorizedException,
                            ObjectDoesNotExistException,
                            ParameterNullException,
                            WrongKindException,
                            WrongMessageTypeException,
                            WrongStateException,
                            UnexpectedFailureException,
                            CommunicationException
Stores the specified fault message for the specified task instance into the database using the task instance ID. The fault message is saved only, that is, the state of the task instance is not changed. Refer to 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.

Parameters:
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.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

IdWrongFormatException
InvalidQNameException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
Since:
5.1.1

setOutputMessage

public void setOutputMessage(java.lang.String tkiid,
                             ClientObjectWrapper outputMessage)
                      throws DataHandlingException,
                             IdWrongFormatException,
                             IdWrongTypeException,
                             NotAuthorizedException,
                             ObjectDoesNotExistException,
                             ParameterNullException,
                             WrongKindException,
                             WrongMessageTypeException,
                             WrongStateException,
                             UnexpectedFailureException,
                             CommunicationException
Stores the output message of the specified task instance into the database using a string representation of the task instance ID. The fault message is saved only, that is, the state of the task instance is not changed. Refer to 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.

Parameters:
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.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

DataHandlingException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
Since:
5.1.1

setOutputMessage

public void setOutputMessage(TKIID tkiid,
                             ClientObjectWrapper outputMessage)
                      throws DataHandlingException,
                             IdWrongFormatException,
                             NotAuthorizedException,
                             ObjectDoesNotExistException,
                             ParameterNullException,
                             WrongKindException,
                             WrongMessageTypeException,
                             WrongStateException,
                             UnexpectedFailureException,
                             CommunicationException
Stores the output message of the specified task instance into the database using the task instance ID. The fault message is saved only, that is, the state of the task instance is not changed. Refer to 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.

Parameters:
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.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

DataHandlingException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
Since:
5.1.1

startTask

public void startTask(java.lang.String tkiid,
                      ClientObjectWrapper input,
                      ReplyHandlerWrapper replyHandler)
               throws AdministratorCannotBeResolvedException,
                      ApplicationVetoException,
                      CannotCreateWorkItemException,
                      IdWrongFormatException,
                      IdWrongTypeException,
                      InvalidLengthException,
                      NotAuthorizedException,
                      ObjectDoesNotExistException,
                      SCAServiceAccessFailureException,
                      SCAServiceResultErrorException,
                      WrongKindException,
                      WrongMessageTypeException,
                      WrongStateException,
                      UnexpectedFailureException,
                      CommunicationException
Asynchronously executes a previously created task using a string representation of the task instance ID. An input message can be passed to specify intial values for the task.

The task instance must be in the ready state. The caller must be a potential starter, the originator, or an administrator of the task. When the task is an originating task, then the caller becomes the starter of the task.

Parameters:
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.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
IdWrongTypeException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
SCAServiceAccessFailureException
SCAServiceResultErrorException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
Since:
6.0

startTask

public void startTask(TKIID tkiid,
                      ClientObjectWrapper input,
                      ReplyHandlerWrapper replyHandler)
               throws AdministratorCannotBeResolvedException,
                      ApplicationVetoException,
                      CannotCreateWorkItemException,
                      IdWrongFormatException,
                      InvalidLengthException,
                      NotAuthorizedException,
                      ObjectDoesNotExistException,
                      SCAServiceAccessFailureException,
                      SCAServiceResultErrorException,
                      WrongKindException,
                      WrongMessageTypeException,
                      WrongStateException,
                      UnexpectedFailureException,
                      CommunicationException
Asynchronously executes a previously created task using the task instance ID. An input message can be passed to specify intial values for the task.

The task instance must be in the ready state. The caller must be a potential starter, the originator, or an administrator of the task. When the task is an originating task, then the caller becomes the starter of the task.

Parameters:
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.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

AdministratorCannotBeResolvedException
ApplicationVetoException
CannotCreateWorkItemException
IdWrongFormatException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
SCAServiceAccessFailureException
SCAServiceResultErrorException
WrongKindException
WrongMessageTypeException
WrongStateException
UnexpectedFailureException
Since:
6.0

startTaskTemplate

public void startTaskTemplate(java.lang.String tktid)
                       throws ApplicationVetoException,
                              IdWrongFormatException,
                              IdWrongTypeException,
                              NotAuthorizedException,
                              ObjectDoesNotExistException,
                              WrongKindException,
                              WrongStateException,
                              UnexpectedFailureException,
                              CommunicationException
This method starts a task template that has been created on-the-fly using a string representation of the task template ID. When a task template is started instances can be created using the task template.

The caller must be an administrator of the task template. The task template must be stopped.

Parameters:
tktid - A string representation of the object ID of the task template to be started.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0.1

startTaskTemplate

public void startTaskTemplate(TKTID tktid)
                       throws ApplicationVetoException,
                              IdWrongFormatException,
                              NotAuthorizedException,
                              ObjectDoesNotExistException,
                              WrongKindException,
                              WrongStateException,
                              UnexpectedFailureException,
                              CommunicationException
This method starts a task template that has been created on-the-fly using the task template ID. When a task template is started instances can be created using the task template.

The caller must be an administrator of the task template. The task template must be stopped.

Parameters:
tktid - The object ID of the task template which is to be stopped.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0.1

stopTaskTemplate

public void stopTaskTemplate(java.lang.String tktid)
                      throws ApplicationVetoException,
                             IdWrongFormatException,
                             IdWrongTypeException,
                             NotAuthorizedException,
                             ObjectDoesNotExistException,
                             WrongKindException,
                             WrongStateException,
                             UnexpectedFailureException,
                             CommunicationException
This method stops a task template that has been created on-the-fly using a string representation of the task template ID. When a task template is in the stopped state no more instances can be created using the task template.

The caller must be an administrator of the task template. The task template must be started.

Parameters:
tktid - A string representation of the object ID of the task template to be stopped.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0.1

stopTaskTemplate

public void stopTaskTemplate(TKTID tktid)
                      throws ApplicationVetoException,
                             IdWrongFormatException,
                             NotAuthorizedException,
                             ObjectDoesNotExistException,
                             WrongKindException,
                             WrongStateException,
                             UnexpectedFailureException,
                             CommunicationException
This method stops a task template that has been created on-the-fly using the task template ID. When a task template is in the stopped state no more instances can be created using the task template.

The caller must be an administrator of the task template. The task template must be started.

Parameters:
tktid - The object ID of the task template which is to be stopped.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0.1

suspend

public void suspend(java.lang.String tkiid)
             throws ApplicationVetoException,
                    IdWrongFormatException,
                    IdWrongTypeException,
                    NotAuthorizedException,
                    ObjectDoesNotExistException,
                    WrongKindException,
                    WrongStateException,
                    UnexpectedFailureException,
                    CommunicationException
Suspends the specified human or participating task instance using a string representation of the task instance ID.

The task instance can be in the ready or claimed state. It can have been escalated. The caller can be the owner, originator, or administrator of the task instance.

Parameters:
tkiid - A string representation of the task instance ID to be suspended.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

suspend

public void suspend(TKIID tkiid)
             throws ApplicationVetoException,
                    IdWrongFormatException,
                    NotAuthorizedException,
                    ObjectDoesNotExistException,
                    WrongKindException,
                    WrongStateException,
                    UnexpectedFailureException,
                    CommunicationException
Suspends the specified human or participating task instance using the task instance ID.

The task instance can be in the ready or claimed state. It can have been escalated. The caller can be the owner, originator, or administrator of the task instance.

Parameters:
tkiid - The object ID of the task instance to be suspended.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

terminate

public void terminate(java.lang.String tkiid)
               throws ApplicationVetoException,
                      IdWrongFormatException,
                      IdWrongTypeException,
                      NotAuthorizedException,
                      ObjectDoesNotExistException,
                      WrongKindException,
                      WrongStateException,
                      UnexpectedFailureException,
                      CommunicationException
Terminates the specified task instance using a string representation of the task instance ID. Terminating an originating task has no impact on the invoked service.

The task instance can be in the ready, claimed, or running state. It can be escalated or suspended. The caller can be the owner, starter, or administrator of the task instance.

Parameters:
tkiid - A string representation of the object ID of the task instance to be terminated.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
IdWrongTypeException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

terminate

public void terminate(TKIID tkiid)
               throws ApplicationVetoException,
                      IdWrongFormatException,
                      NotAuthorizedException,
                      ObjectDoesNotExistException,
                      WrongKindException,
                      WrongStateException,
                      UnexpectedFailureException,
                      CommunicationException
Terminates the specified task instance using the task instance ID. Terminating an originating task has no impact on the invoked service.

The task instance can be in the ready, claimed, or running state. It can be escalated or suspended. The caller can be the owner, starter, or administrator of the task instance.

Parameters:
tkiid - The object ID of the task instance to be terminated.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
IdWrongFormatException
NotAuthorizedException
ObjectDoesNotExistException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

transferWorkItem

public void transferWorkItem(java.lang.String tkiid,
                             int assignmentReason,
                             java.lang.String fromUserID,
                             java.lang.String toUserID)
                      throws ApplicationVetoException,
                             EverybodyWorkItemException,
                             IdWrongFormatException,
                             IdWrongTypeException,
                             InvalidAssignmentReasonException,
                             InvalidLengthException,
                             NotAuthorizedException,
                             WorkItemDoesNotExistException,
                             ObjectDoesNotExistException,
                             ParameterNullException,
                             TaskDelegationNotSupportedException,
                             WorkItemManagerException,
                             WrongKindException,
                             WrongStateException,
                             UnexpectedFailureException,
                             CommunicationException
Transfers the specified work item to the specified user using a string representation of the task instance ID.

The caller must be an owner, starter, originator, or administrator of the task instance. The task can be escalated.

The following specific rules apply for the transfer of work items:

Parameters:
tkiid - A string representation of 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 getAssignmentReason for valid values.
fromUserID - The user the work item belongs to.
toUserID - The user the work item is to be transferred to. It is not checked whether the user exists.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
EverybodyWorkItemException
IdWrongFormatException
IdWrongTypeException
InvalidAssignmentReasonException
InvalidLengthException
NotAuthorizedException
WorkItemDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
TaskDelegationNotSupportedException
WorkItemManagerException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0 - introduced in 5.1.1

transferWorkItem

public void transferWorkItem(TKIID tkiid,
                             int assignmentReason,
                             java.lang.String fromUserID,
                             java.lang.String toUserID)
                      throws ApplicationVetoException,
                             EverybodyWorkItemException,
                             IdWrongFormatException,
                             InvalidAssignmentReasonException,
                             InvalidLengthException,
                             NotAuthorizedException,
                             WorkItemDoesNotExistException,
                             ObjectDoesNotExistException,
                             ParameterNullException,
                             TaskDelegationNotSupportedException,
                             WorkItemManagerException,
                             WrongKindException,
                             WrongStateException,
                             UnexpectedFailureException,
                             CommunicationException
Transfers a work item for the specified task instance to the specified user using the task instance ID.

The caller must be an owner, starter, originator, or administrator of the task instance. The task can be escalated.

The following specific rules apply for the transfer of work items:

Parameters:
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 getAssignmentReason for valid values.
fromUserID - The user the work item belongs to.
toUserID - The user the work item is to be transferred to. It is not checked whether the user exists.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
EverybodyWorkItemException
IdWrongFormatException
InvalidAssignmentReasonException
InvalidLengthException
NotAuthorizedException
WorkItemDoesNotExistException
ObjectDoesNotExistException
ParameterNullException
TaskDelegationNotSupportedException
WorkItemManagerException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0 - introduced in 5.1.1

update

public void update(Task task)
            throws ApplicationVetoException,
                   InvalidLengthException,
                   NotAuthorizedException,
                   ObjectDoesNotExistException,
                   ParameterNullException,
                   PropertyVetoException,
                   WrongKindException,
                   WrongStateException,
                   UnexpectedFailureException,
                   CommunicationException
Updates a persistently stored task instance. The task and the properties to be updated are identified by the provided task object. Only the properties changed within the previously retrieved task instance are updated. When the same task property is updated in parallel, the last writer wins. Note that only the following properties are allowed to be updated after the task has been started - doumentations and custom properties can be updated via the HumanTaskManager bean:

The task can be in any state. It can be escalated. The caller must be the owner, the starter, an editor, or an administrator of the task instance.

Parameters:
task - The task instance and the properties to be updated.
Throws:
CommunicationException - Thrown when the method failed due to a communication or system-level failure.

ApplicationVetoException
InvalidLengthException
NotAuthorizedException
ObjectDoesNotExistException
ParameterNullException
PropertyVetoException
WrongKindException
WrongStateException
UnexpectedFailureException
Since:
6.0

update

public 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
Updates a task instance that has been created on-the-fly using a string representation of the task instance ID. All properties are changed according to the values provided by the task model. Actually, the specified task instance is deleted and a new task instance is created.

The task must still be in the inactive state. The caller must be the originator of the task instance.

Parameters:
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 definitions. If not specified, the application of the updated task instance is kept.
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.
Throws:
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
Since:
6.0.1

update

public 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
Updates a task instance that has been created on-the-fly using the task instance ID. All properties are changed according to the values provided by the task model. Actually, the specified task instance is deleted and a new task instance is created.

The task must still be in the inactive state. The caller must be the originator of the task instance.

Parameters:
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 definitions. If not specified, the application of the updated task instance is kept.
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.
Throws:
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
Since:
6.0.1