com.ibm.task.clientmodel.bean

Class TaskInstanceBean

  • java.lang.Object
    • com.ibm.task.clientmodel.bean.TaskInstanceBean
  • All Implemented Interfaces:
    Task, java.io.Serializable


    public class TaskInstanceBean
    extends java.lang.Object
    implements Task

    Accesses the properties of the original Task object and adds metadata for national language support and converters.

    A task instance represents a piece of work. It contains all data necessary to perform the task. For example, a task that is associated with a group of potential owners allows a person that belongs to the group to claim the task, work on the task, and to complete the task.

    A TaskInstanceBean object can be instantiated from a QueryResultSet object or from a Task object.
    If the bean was instantiated from an original object returned by the Human Task Manager API, all properties are loaded. If the bean is instantiated from a query, the following properties are loaded from the query result set:

    • ID
    • activationTime
    • applicationDefaultsID
    • applicationName
    • workBasketName
    • assignmentType
    • invokedInstanceType
    • autoDeletionMode
    • businessRelevant
    • completionTime
    • containmentContextID
    • contextAuthorizationOfOwner
    • dueTime
    • deletionTime
    • escalatedUpdateable
    • expirationTime
    • firstActivationTime
    • followOnTaskID
    • positionInHierarchy
    • adHoc
    • escalated
    • child
    • read
    • inheritedAuthorization
    • inline
    • waitingForSubTask
    • kind
    • lastModificationTime
    • lastStateChangeTime
    • name
    • namespace
    • definitionName
    • definitionNamespace
    • originator
    • owner
    • parentContextID
    • invokedInstanceID
    • priority
    • startTime
    • starter
    • state
    • substitutionPolicy
    • supportsAutomaticClaim
    • supportsClaimIfSuspended
    • supportsDelegation
    • supportsSubTasks
    • supportsFollowOnTasks
    • suspended
    • taskTemplateID
    • topLevelTaskID
    • type
    • taskTemplateName
    If the property is not found in the query result set, the property remains empty. Accessing an empty property requires the bean to load the missing information from the server.

    Use the static method getLabel(String, Locale) to retrieve the localized label for a property. Use the static method getConverter(String) to retrieve a converter for a property. The return value might be null, as converters are optional.

    See Also:
    Task, QueryResultSet, Serialized Form
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        (C) Copyright IBM Corporation 2004, 2012.
        See Also:
        Constant Field Values
      • ACTIVATIONTIME_PROPERTY

        public static final java.lang.String ACTIVATIONTIME_PROPERTY
        Use the property name to determine labels and converters for the activationTime property.
        See Also:
        Constant Field Values
      • APPLICATIONNAME_PROPERTY

        public static final java.lang.String APPLICATIONNAME_PROPERTY
        Use the property name to determine labels and converters for the applicationName property.
        See Also:
        Constant Field Values
      • WORKBASKETNAME_PROPERTY

        public static final java.lang.String WORKBASKETNAME_PROPERTY
        Use the property name to determine labels and converters for the workBasketName property.
        See Also:
        Constant Field Values
      • ASSIGNMENTTYPE_PROPERTY

        public static final java.lang.String ASSIGNMENTTYPE_PROPERTY
        Use the property name to determine labels and converters for the assignmentType property.
        See Also:
        Constant Field Values
      • INVOKEDINSTANCETYPE_PROPERTY

        public static final java.lang.String INVOKEDINSTANCETYPE_PROPERTY
        Use the property name to determine labels and converters for the invokedInstanceType property.
        See Also:
        Constant Field Values
      • AUTODELETIONMODE_PROPERTY

        public static final java.lang.String AUTODELETIONMODE_PROPERTY
        Use the property name to determine labels and converters for the autoDeletionMode property.
        See Also:
        Constant Field Values
      • BUSINESSRELEVANT_PROPERTY

        public static final java.lang.String BUSINESSRELEVANT_PROPERTY
        Use the property name to determine labels and converters for the businessRelevant property.
        See Also:
        Constant Field Values
      • COMPLETIONTIME_PROPERTY

        public static final java.lang.String COMPLETIONTIME_PROPERTY
        Use the property name to determine labels and converters for the completionTime property.
        See Also:
        Constant Field Values
      • CONTAINMENTCONTEXTID_PROPERTY

        public static final java.lang.String CONTAINMENTCONTEXTID_PROPERTY
        Use the property name to determine labels and converters for the containmentContextID property.
        See Also:
        Constant Field Values
      • CUSTOMPROPERTY_PROPERTY

        public static final java.lang.String CUSTOMPROPERTY_PROPERTY
        Use the property name to determine labels and converters for the customProperty property.
        See Also:
        Constant Field Values
      • DESCRIPTION_PROPERTY

        public static final java.lang.String DESCRIPTION_PROPERTY
        Use the property name to determine labels and converters for the description property.
        See Also:
        Constant Field Values
      • DISPLAYNAME_PROPERTY

        public static final java.lang.String DISPLAYNAME_PROPERTY
        Use the property name to determine labels and converters for the displayName property.
        See Also:
        Constant Field Values
      • ESCALATED_PROPERTY

        public static final java.lang.String ESCALATED_PROPERTY
        Use the property name to determine labels and converters for the escalated property.
        See Also:
        Constant Field Values
      • ESCALATEDUPDATEABLE_PROPERTY

        public static final java.lang.String ESCALATEDUPDATEABLE_PROPERTY
        Use the property name to determine labels and converters for the escalatedUpdateable property.
        See Also:
        Constant Field Values
      • CHILD_PROPERTY

        public static final java.lang.String CHILD_PROPERTY
        Use the property name to determine labels and converters for the child property.
        See Also:
        Constant Field Values
      • READ_PROPERTY

        public static final java.lang.String READ_PROPERTY
        Use the property name to determine labels and converters for the read property.
        See Also:
        Constant Field Values
      • EXPIRATIONTIME_PROPERTY

        public static final java.lang.String EXPIRATIONTIME_PROPERTY
        Use the property name to determine labels and converters for the expirationTime property.
        See Also:
        Constant Field Values
      • DELETIONTIME_PROPERTY

        public static final java.lang.String DELETIONTIME_PROPERTY
        Use the property name to determine labels and converters for the deletionTime property.
        See Also:
        Constant Field Values
      • FIRSTACTIVATIONTIME_PROPERTY

        public static final java.lang.String FIRSTACTIVATIONTIME_PROPERTY
        Use the property name to determine labels and converters for the firstActivationTime property.
        See Also:
        Constant Field Values
      • ID_PROPERTY

        public static final java.lang.String ID_PROPERTY
        Use the property name to determine labels and converters for the ID property.
        See Also:
        Constant Field Values
      • INHERITEDAUTHORIZATION_PROPERTY

        public static final java.lang.String INHERITEDAUTHORIZATION_PROPERTY
        Use the property name to determine labels and converters for the inheritedAuthorization property.
        See Also:
        Constant Field Values
      • INPUTMESSAGETYPENAME_PROPERTY

        public static final java.lang.String INPUTMESSAGETYPENAME_PROPERTY
        Use the property name to determine labels and converters for the inputMessageTypeName property.
        See Also:
        Constant Field Values
      • KIND_PROPERTY

        public static final java.lang.String KIND_PROPERTY
        Use the property name to determine labels and converters for the kind property.
        See Also:
        Constant Field Values
      • LASTMODIFICATIONTIME_PROPERTY

        public static final java.lang.String LASTMODIFICATIONTIME_PROPERTY
        Use the property name to determine labels and converters for the lastModificationTime property.
        See Also:
        Constant Field Values
      • LASTSTATECHANGETIME_PROPERTY

        public static final java.lang.String LASTSTATECHANGETIME_PROPERTY
        Use the property name to determine labels and converters for the lastStateChangeTime property.
        See Also:
        Constant Field Values
      • NAME_PROPERTY

        public static final java.lang.String NAME_PROPERTY
        Use the property name to determine labels and converters for the name property.
        See Also:
        Constant Field Values
      • ORIGINATOR_PROPERTY

        public static final java.lang.String ORIGINATOR_PROPERTY
        Use the property name to determine labels and converters for the originator property.
        See Also:
        Constant Field Values
      • OUTPUTMESSAGETYPENAME_PROPERTY

        public static final java.lang.String OUTPUTMESSAGETYPENAME_PROPERTY
        Use the property name to determine labels and converters for the outputMessageTypeName property.
        See Also:
        Constant Field Values
      • OWNER_PROPERTY

        public static final java.lang.String OWNER_PROPERTY
        Use the property name to determine labels and converters for the owner property.
        See Also:
        Constant Field Values
      • PARENTCONTEXTID_PROPERTY

        public static final java.lang.String PARENTCONTEXTID_PROPERTY
        Use the property name to determine labels and converters for the parentContextID property.
        See Also:
        Constant Field Values
      • INVOKEDINSTANCEID_PROPERTY

        public static final java.lang.String INVOKEDINSTANCEID_PROPERTY
        Use the property name to determine labels and converters for the invokedInstanceID property.
        See Also:
        Constant Field Values
      • PRIORITY_PROPERTY

        public static final java.lang.String PRIORITY_PROPERTY
        Use the property name to determine labels and converters for the priority property.
        See Also:
        Constant Field Values
      • STARTTIME_PROPERTY

        public static final java.lang.String STARTTIME_PROPERTY
        Use the property name to determine labels and converters for the startTime property.
        See Also:
        Constant Field Values
      • STATE_PROPERTY

        public static final java.lang.String STATE_PROPERTY
        Use the property name to determine labels and converters for the state property.
        See Also:
        Constant Field Values
      • SUBSTITUTIONPOLICY_PROPERTY

        public static final java.lang.String SUBSTITUTIONPOLICY_PROPERTY
        Use the property name to determine labels and converters for the substitutionPolicy property.
        See Also:
        Constant Field Values
      • SUSPENDED_PROPERTY

        public static final java.lang.String SUSPENDED_PROPERTY
        Use the property name to determine labels and converters for the property suspended.
        See Also:
        Constant Field Values
      • TYPE_PROPERTY

        public static final java.lang.String TYPE_PROPERTY
        Use the property name to determine labels and converters for type.
        See Also:
        Constant Field Values
      • ADHOC_PROPERTY

        public static final java.lang.String ADHOC_PROPERTY
        Use the property name to determine labels and converters for the property adHoc.
        See Also:
        Constant Field Values
      • DUETIME_PROPERTY

        public static final java.lang.String DUETIME_PROPERTY
        Use the property name to determine labels and converters for the property dueTime.
        See Also:
        Constant Field Values
      • RESUMPTIONTIME_PROPERTY

        public static final java.lang.String RESUMPTIONTIME_PROPERTY
        Use the property name to determine labels and converters for the property resumptionTime.
        See Also:
        Constant Field Values
      • INLINE_PROPERTY

        public static final java.lang.String INLINE_PROPERTY
        Use the property name to determine labels and converters for the property inline.
        See Also:
        Constant Field Values
      • NAMESPACE_PROPERTY

        public static final java.lang.String NAMESPACE_PROPERTY
        Use the property name to determine labels and converters for the property namespace.
        See Also:
        Constant Field Values
      • POSITIONINHIERARCHY_PROPERTY

        public static final java.lang.String POSITIONINHIERARCHY_PROPERTY
        Use the property name to determine labels and converters for the property positionInHierarchy.
        See Also:
        Constant Field Values
      • STARTER_PROPERTY

        public static final java.lang.String STARTER_PROPERTY
        Use the property name to determine labels and converters for the property starter.
        See Also:
        Constant Field Values
      • SUPPORTSAUTOMATICCLAIM_PROPERTY

        public static final java.lang.String SUPPORTSAUTOMATICCLAIM_PROPERTY
        Use the property name to determine labels and converters for the property automaticClaim.
        See Also:
        Constant Field Values
      • SUPPORTSCLAIMIFSUSPENDED_PROPERTY

        public static final java.lang.String SUPPORTSCLAIMIFSUSPENDED_PROPERTY
        Use the property name to determine labels and converters for the property supportsClaimIfSuspended.
        See Also:
        Constant Field Values
      • SUPPORTSDELEGATION_PROPERTY

        public static final java.lang.String SUPPORTSDELEGATION_PROPERTY
        Use the property name to determine labels and converters for the property supportsDelegation.
        See Also:
        Constant Field Values
      • SUPPORTSSUBTASKS_PROPERTY

        public static final java.lang.String SUPPORTSSUBTASKS_PROPERTY
        Use the property name to determine labels and converters for the property supportsSubTasks.
        See Also:
        Constant Field Values
      • SUPPORTSFOLLOWONTASKS_PROPERTY

        public static final java.lang.String SUPPORTSFOLLOWONTASKS_PROPERTY
        Use the property name to determine labels and converters for the property supportsFollowOnTasks.
        See Also:
        Constant Field Values
      • WAITINGFORSUBTASK_PROPERTY

        public static final java.lang.String WAITINGFORSUBTASK_PROPERTY
        Use the property name to determine labels and converters for the property waitingForSubTask.
        See Also:
        Constant Field Values
      • TASKTEMPLATENAME_PROPERTY

        public static final java.lang.String TASKTEMPLATENAME_PROPERTY
        Use the property name to determine labels and converters for the property task template name.
        See Also:
        Constant Field Values
      • TASKTEMPLATEDISPLAYNAME_PROPERTY

        public static final java.lang.String TASKTEMPLATEDISPLAYNAME_PROPERTY
        Use the property name to determine labels and converters for the property task template display name.
        See Also:
        Constant Field Values
      • DURATIONUNTILDUE_PROPERTY

        public static final java.lang.String DURATIONUNTILDUE_PROPERTY
        Use the property name to determine converter for the durationUntilDue property.
        See Also:
        Constant Field Values
      • DURATIONUNTILEXPIRES_PROPERTY

        public static final java.lang.String DURATIONUNTILEXPIRES_PROPERTY
        Use the property name to determine converter for the durationUntilExpires property.
        See Also:
        Constant Field Values
      • TASKTEMPLATEID_PROPERTY

        public static final java.lang.String TASKTEMPLATEID_PROPERTY
        Use the property name to determine labels and converters for thetaskTemplateID property
        See Also:
        Constant Field Values
      • VALIDFROMTIME_PROPERTY

        public static final java.lang.String VALIDFROMTIME_PROPERTY
        Use the property name to determine labels and converters for thevalidFromTime property
        See Also:
        Constant Field Values
      • SNAPSHOTID_PROPERTY

        public static final java.lang.String SNAPSHOTID_PROPERTY
        Use the property name to determine labels and converters for the snapshotID property.
        See Also:
        Constant Field Values
      • SNAPSHOTNAME_PROPERTY

        public static final java.lang.String SNAPSHOTNAME_PROPERTY
        Use the property name to determine labels and converters for the snapshotName property.
        See Also:
        Constant Field Values
      • TRACKNAME_PROPERTY

        public static final java.lang.String TRACKNAME_PROPERTY
        Use the property name to determine labels and converters for the trackName property.
        See Also:
        Constant Field Values
      • PROCESSAPPNAME_PROPERTY

        public static final java.lang.String PROCESSAPPNAME_PROPERTY
        Use the property name to determine labels and converters for the processAppName property.
        See Also:
        Constant Field Values
      • PROCESSAPPACRONYM_PROPERTY

        public static final java.lang.String PROCESSAPPACRONYM_PROPERTY
        Use the property name to determine labels and converters for the processAppAcronym property.
        See Also:
        Constant Field Values
      • TOOLKITSNAPSHOTID_PROPERTY

        public static final java.lang.String TOOLKITSNAPSHOTID_PROPERTY
        Use the property name to determine labels and converters for the toolkitSnapshotID property.
        See Also:
        Constant Field Values
      • TOOLKITSNAPSHOTNAME_PROPERTY

        public static final java.lang.String TOOLKITSNAPSHOTNAME_PROPERTY
        Use the property name to determine labels and converters for the toolkitSnapshotName property.
        See Also:
        Constant Field Values
      • TOOLKITNAME_PROPERTY

        public static final java.lang.String TOOLKITNAME_PROPERTY
        Use the property name to determine labels and converters for the toolkitName property.
        See Also:
        Constant Field Values
      • TOOLKITACRONYM_PROPERTY

        public static final java.lang.String TOOLKITACRONYM_PROPERTY
        Use the property name to determine labels and converters for the toolkitAcronym property.
        See Also:
        Constant Field Values
      • TOPLEVELTOOLKITNAME_PROPERTY

        public static final java.lang.String TOPLEVELTOOLKITNAME_PROPERTY
        Use the property name to determine labels and converters for the topLevelToolkitName property.
        See Also:
        Constant Field Values
      • TOPLEVELTOOLKITACRONYM_PROPERTY

        public static final java.lang.String TOPLEVELTOOLKITACRONYM_PROPERTY
        Use the property name to determine labels and converters for the topLevelToolkitAcronym property.
        See Also:
        Constant Field Values
      • TIP_PROPERTY

        public static final java.lang.String TIP_PROPERTY
        Use the property name to determine labels and converters for the tip property.
        See Also:
        Constant Field Values
      • CUSTOMTEXT1_PROPERTY

        public static final java.lang.String CUSTOMTEXT1_PROPERTY
        Use the property name to determine labels and converters for the customText1 property.
        See Also:
        Constant Field Values
      • CUSTOMTEXT2_PROPERTY

        public static final java.lang.String CUSTOMTEXT2_PROPERTY
        Use the property name to determine labels and converters for the customText2 property.
        See Also:
        Constant Field Values
      • CUSTOMTEXT3_PROPERTY

        public static final java.lang.String CUSTOMTEXT3_PROPERTY
        Use the property name to determine labels and converters for the customText1 property.
        See Also:
        Constant Field Values
      • CUSTOMTEXT4_PROPERTY

        public static final java.lang.String CUSTOMTEXT4_PROPERTY
        Use the property name to determine labels and converters for the customText1 property.
        See Also:
        Constant Field Values
      • CUSTOMTEXT5_PROPERTY

        public static final java.lang.String CUSTOMTEXT5_PROPERTY
        Use the property name to determine labels and converters for the customText1 property.
        See Also:
        Constant Field Values
      • CUSTOMTEXT6_PROPERTY

        public static final java.lang.String CUSTOMTEXT6_PROPERTY
        Use the property name to determine labels and converters for the customText1 property.
        See Also:
        Constant Field Values
      • CUSTOMTEXT7_PROPERTY

        public static final java.lang.String CUSTOMTEXT7_PROPERTY
        Use the property name to determine labels and converters for the customText1 property.
        See Also:
        Constant Field Values
      • CUSTOMTEXT8_PROPERTY

        public static final java.lang.String CUSTOMTEXT8_PROPERTY
        Use the property name to determine labels and converters for the customText1 property.
        See Also:
        Constant Field Values
    • Constructor Detail

      • TaskInstanceBean

        public TaskInstanceBean(QueryResultSet resultSet,
                        HTMConnection htmConnection)
        Constructs a new TaskInstanceBean from a QueryResultSet.
        Parameters:
        resultSet - The result object of a query.
        htmConnection - The connection to the HumanTaskManagerService API.
      • TaskInstanceBean

        public TaskInstanceBean(QueryResultSet resultSet,
                        java.lang.String taskDataViewName,
                        HTMConnection htmConnection)
        Constructs a new TaskInstanceBean from a QueryResultSet.
        Parameters:
        resultSet - The result object of a query.
        taskDataViewName - Name of the view from where to retrieve task attributes
        htmConnection - The connection to the HumanTaskManagerService API.
      • TaskInstanceBean

        public TaskInstanceBean(QueryResultSet resultSet,
                        HTMConnection htmConnection,
                        java.util.Locale locale)
        Constructs a new TaskInstanceBean from a QueryResultSet.
        Parameters:
        resultSet - The result object of a query.
        htmConnection - The connection to the HumanTaskManagerService API.
        locale - The locale of the locale dependant properties.
      • TaskInstanceBean

        public TaskInstanceBean(QueryResultSet resultSet,
                        java.lang.String taskDataViewName,
                        HTMConnection htmConnection,
                        java.util.Locale locale)
        Constructs a new TaskInstanceBean from a QueryResultSet.
        Parameters:
        resultSet - The result object of a query.
        taskDataViewName - Name of the view from where to retrieve task attributes
        htmConnection - The connection to the HumanTaskManagerService API.
        locale - The locale of the locale dependant properties.
      • TaskInstanceBean

        public TaskInstanceBean(Task task,
                        HTMConnection htmConnection)
        Constructs a TaskInstanceBean from an original Task object.
        Parameters:
        task - The original data object.
        htmConnection - The connection to the HumanTaskManagerService API.
      • TaskInstanceBean

        protected TaskInstanceBean(TKIID id,
                        HTMConnection htmConnection,
                        java.util.Locale locale)
        Constructs a TaskInstanceBean from a task instance id.
        Parameters:
        id - The task instance id.
        htmConnection - The connection to the HumanTaskManagerService API.
        locale - The locale of the locale dependant properties.
    • Method Detail

      • getConverter

        public static SimpleConverter getConverter(java.lang.String propertyName)
        Returns the default converter for a given property.
        Parameters:
        propertyName - The name for the property.
        Returns:
        The converter instance if one has been registered with propertyName, null otherwise.
      • getLabel

        public static java.lang.String getLabel(java.lang.String propertyName)
        Returns the resource bundle key for a property
        Parameters:
        propertyName - The name for the property.
        Returns:
        The resource bundle key for the property.
      • getLabel

        public static java.lang.String getLabel(java.lang.String propertyName,
                                java.util.Locale locale)
        Returns the label for a property from the resource bundle. If no label is found in the resource bundle the resource bundle key for the property is returned.
        Parameters:
        propertyName - The name for the property.
        locale - The locale.
        Returns:
        The label or the resource bundle key for the property.
      • isValid

        public static boolean isValid(java.lang.String propertyName)
        Checks if the property is valid.
        Parameters:
        propertyName - The name of the property to be checked.
        Returns:
        True, if the propertyName is a known property for an object of this class.
      • getDescription

        public com.ibm.bpc.clientcore.util.LocalisedString getDescription()
        Returns the localised description.
        Returns:
        The localised description.
      • getDescription

        public java.lang.String getDescription(java.util.Locale locale)
        Returns the property description.
        Specified by:
        getDescription in interface Task
        Parameters:
        locale - The locale for which the description is to be provided.
        See Also:
        Task.getDescription(java.util.Locale)
      • getDisplayName

        public com.ibm.bpc.clientcore.util.LocalisedString getDisplayName()
        Returns the localised display name.
        Returns:
        The localised display name.
      • getDisplayName

        public java.lang.String getDisplayName(java.util.Locale locale)
        Returns the property displayName.
        Specified by:
        getDisplayName in interface Task
        Parameters:
        locale - The locale for which the display name is to be provided.
        See Also:
        Task.getDisplayName(java.util.Locale)
      • getDueTime

        public java.util.Calendar getDueTime()
        Returns the property dueTime.
        Specified by:
        getDueTime in interface Task
        See Also:
        Task.getDueTime()
      • getFaultMessageWrapper

        public MessageWrapper getFaultMessageWrapper()
                                              throws ClientException
        Retrieves the fault message. If the task instance is in state inactive an empty message is returned.
        Returns:
        The wrapped message.
        Throws:
        ClientException
      • getKind

        public int getKind()
        Returns the property kind.
        Specified by:
        getKind in interface Task
        See Also:
        Task.getKind()
      • getName

        public java.lang.String getName()
        Returns the property name.
        Specified by:
        getName in interface Task
        See Also:
        Task.getName()
      • getOriginal

        protected Task getOriginal()
      • getOwner

        public java.lang.String getOwner()
        Returns the property owner.
        Specified by:
        getOwner in interface Task
        See Also:
        Task.getOwner()
      • getTaskTemplateName

        public java.lang.String getTaskTemplateName()
        Returns the property taskTemplateName.
        Specified by:
        getTaskTemplateName in interface Task
      • getType

        public java.lang.String getType()
        Returns the property type.
        Specified by:
        getType in interface Task
        See Also:
        Task.getType()
      • isAdHoc

        public boolean isAdHoc()
        Returns the property adHoc.
        Specified by:
        isAdHoc in interface Task
        See Also:
        Task.isAdHoc()
      • isChild

        public boolean isChild()
        Returns the property isChild.
        Specified by:
        isChild in interface Task
        See Also:
        Task.isChild()
      • isRead

        public boolean isRead()
        Returns the property isRead.
        Specified by:
        isRead in interface Task
        See Also:
        Task.isRead()
      • isInline

        public boolean isInline()
        Returns the property inline.
        Specified by:
        isInline in interface Task
        See Also:
        Task.isInline()
      • setBusinessRelevance

        public void setBusinessRelevance(boolean arg0)
        Sets the property businessRelevance.
        Specified by:
        setBusinessRelevance in interface Task
        Parameters:
        arg0 - An indication whether the task instance is business relevant. True states that the task is business relevant. False states that the task is not business relevant.
        See Also:
        Task.setBusinessRelevance(boolean)
      • isBusinessRelevanceUpdateable

        public boolean isBusinessRelevanceUpdateable()
        Signals whether the business relevance property can be changed for the kind and current state of the object.
        Specified by:
        isBusinessRelevanceUpdateable in interface Task
      • setContextAuthorizationOfOwner

        public void setContextAuthorizationOfOwner(int arg0)
        Sets the property contextAuthorizationOfOwner.
        Specified by:
        setContextAuthorizationOfOwner in interface Task
        Parameters:
        arg0 - The authorization rights of the task owner for the associated context.

        Possible values are: AUTH_NONE, AUTH_READER.

        See Also:
        Task.setContextAuthorizationOfOwner(int)
      • isContextAuthorizationOfOwnerUpdateable

        public boolean isContextAuthorizationOfOwnerUpdateable()
        Signals whether the context authorization property can be changed for the kind and current state of the object.
        Specified by:
        isContextAuthorizationOfOwnerUpdateable in interface Task
      • isDescriptionUpdateable

        public boolean isDescriptionUpdateable()
        Signals whether the description property can be changed for the kind and current state of the object.
        Specified by:
        isDescriptionUpdateable in interface Task
      • isDisplayNameUpdateable

        public boolean isDisplayNameUpdateable()
        Signals whether the display name property can be changed for the kind and current state of the object.
        Specified by:
        isDisplayNameUpdateable in interface Task
      • isDurationUntilDeletedUpdateable

        public boolean isDurationUntilDeletedUpdateable()
        Signals whether the duration until deleted property can be changed for the kind and current state of the object.
        Specified by:
        isDurationUntilDeletedUpdateable in interface Task
      • isDurationUntilDueUpdateable

        public boolean isDurationUntilDueUpdateable()
        Signals whether the duration until due property can be changed for the kind and current state of the object.
        Specified by:
        isDurationUntilDueUpdateable in interface Task
      • isDurationUntilExpiresUpdateable

        public boolean isDurationUntilExpiresUpdateable()
        Signals whether the duration until expires property can be changed for the kind and current state of the object.
        Specified by:
        isDurationUntilExpiresUpdateable in interface Task
      • setDueTime

        public void setDueTime(java.util.Calendar arg0)
        Sets the property dueTime.
        Specified by:
        setDueTime in interface Task
        Parameters:
        arg0 - The time when the task instance is expected to become due. Note that setting the due time to null is not accepted by the update method, that is, an exception will be thrown,
        See Also:
        Task.setDueTime(java.util.Calendar)
      • isDueTimeUpdateable

        public boolean isDueTimeUpdateable()
        Signals whether the due time property can be changed for the kind and current state of the object.
        Specified by:
        isDueTimeUpdateable in interface Task
      • setExpirationTime

        public void setExpirationTime(java.util.Calendar arg0)
        Sets the property expirationTime.
        Specified by:
        setExpirationTime in interface Task
        Parameters:
        arg0 - The time when the task instance expires. Note that setting the expiration time to null is not accepted by the update method, that is, an exception will be thrown,
        See Also:
        Task.setExpirationTime(java.util.Calendar)
      • isExpirationTimeUpdateable

        public boolean isExpirationTimeUpdateable()
        Signals whether the expiration time property can be changed for the kind and current state of the object.
        Specified by:
        isExpirationTimeUpdateable in interface Task
      • setDeletionTime

        public void setDeletionTime(java.util.Calendar arg0)
        Sets the property deletionTime.
        Specified by:
        setDeletionTime in interface Task
        Parameters:
        arg0 - The time when the task instance is automatically deleted. Note that setting the deletion time to null is not accepted by the update method, that is, an exception will be thrown,
        See Also:
        Task.setDeletionTime(java.util.Calendar)
      • isDeletionTimeUpdateable

        public boolean isDeletionTimeUpdateable()
        Signals whether the deletion time property can be changed for the kind and current state of the object.
        Specified by:
        isDeletionTimeUpdateable in interface Task
      • setEscalated

        public void setEscalated(boolean escalatedState)
        Sets the property escalated.
        Specified by:
        setEscalated in interface Task
        Parameters:
        escalatedState -
      • setChild

        public void setChild(boolean childState)
        Sets the property child.
        Parameters:
        childState -
      • setRead

        public void setRead(boolean readState)
        Sets the property read.
        Specified by:
        setRead in interface Task
        Parameters:
        readState -
      • isEventHandlerNameUpdateable

        public boolean isEventHandlerNameUpdateable()
        Signals whether the event handler name property can be changed for the kind and current state of the object.
        Specified by:
        isEventHandlerNameUpdateable in interface Task
      • setWorkBasketName

        public void setWorkBasketName(java.lang.String arg0)
        Sets the property workBasketName.
        Specified by:
        setWorkBasketName in interface Task
        Parameters:
        arg0 - The name of the work basket to be associated. Null means that the task is no longer associated to any work basket.
        See Also:
        Task.setWorkBasketName(java.lang.String)
      • isWorkBasketNameUpdateable

        public boolean isWorkBasketNameUpdateable()
        Signals whether the work basket name property can be changed for the kind and current state of the object.
        Specified by:
        isWorkBasketNameUpdateable in interface Task
      • setName

        public void setName(java.lang.String arg0)
        Sets the property name.
        Specified by:
        setName in interface Task
        Parameters:
        arg0 - The new name of the task instance.
        See Also:
        Task.setName(java.lang.String)
      • isNameUpdateable

        public boolean isNameUpdateable()
        Signals whether the name property can be changed for the kind and current state of the object.
        Specified by:
        isNameUpdateable in interface Task
      • isNamespaceUpdateable

        public boolean isNamespaceUpdateable()
        Signals whether the namespace property can be changed for the kind and current state of the object.
        Specified by:
        isNamespaceUpdateable in interface Task
      • isParentContextIDUpdateable

        public boolean isParentContextIDUpdateable()
        Signals whether the parent context i d property can be changed for the kind and current state of the object.
        Specified by:
        isParentContextIDUpdateable in interface Task
      • isPriorityUpdateable

        public boolean isPriorityUpdateable()
        Signals whether the priority property can be changed for the kind and current state of the object.
        Specified by:
        isPriorityUpdateable in interface Task
      • setState

        public void setState(java.lang.Integer newState)
        Sets the property state.
        Parameters:
        newState -
      • setSupportsClaimIfSuspended

        public void setSupportsClaimIfSuspended(boolean arg0)
        Sets the property supportsClaimIfSuspended.
        Specified by:
        setSupportsClaimIfSuspended in interface Task
        Parameters:
        arg0 - An indication whether the task can be claimed even if it is suspended. True states that the task can be claimed if it is suspended. False states that the task cannot be claimed if it is suspended.
        See Also:
        Task.setSupportsClaimIfSuspended(boolean)
      • setSupportsDelegation

        public void setSupportsDelegation(boolean arg0)
        Sets the property supportsDelegation.
        Specified by:
        setSupportsDelegation in interface Task
        Parameters:
        arg0 - An indication whether the task instance supports delegation. True states that the task supports delegation. False states that the task does not support delegation.
        See Also:
        Task.setSupportsDelegation(boolean)
      • isSupportsDelegationUpdateable

        public boolean isSupportsDelegationUpdateable()
        Signals whether the supports delegation property can be changed for the kind and current state of the object.
        Specified by:
        isSupportsDelegationUpdateable in interface Task
      • setSupportsSubTasks

        public void setSupportsSubTasks(boolean arg0)
        Sets the property supportsSubTasks.
        Specified by:
        setSupportsSubTasks in interface Task
        Parameters:
        arg0 - An indication whether the task instance supports the creation of subtasks. True states that the task supports the creation of subtasks. False states that the task does not support the creation of subtasks.
        See Also:
        Task.setSupportsSubTasks(boolean)
      • isSupportsSubTasksUpdateable

        public boolean isSupportsSubTasksUpdateable()
        Signals whether the supports sub task property can be changed for the kind and current state of the object.
        Specified by:
        isSupportsSubTasksUpdateable in interface Task
      • setSupportsFollowOnTasks

        public void setSupportsFollowOnTasks(boolean arg0)
        Sets the property supportsFollowOnTasks.
        Specified by:
        setSupportsFollowOnTasks in interface Task
        Parameters:
        arg0 - An indication whether the task instance supports the creation of follow-on tasks. True states that the task supports the creation of follow-on tasks. False states that the task does not support the creation of follow-on tasks.
        See Also:
        Task.setSupportsFollowOnTasks(boolean)
      • isSupportsFollowOnTasksUpdateable

        public boolean isSupportsFollowOnTasksUpdateable()
        Signals whether the supports follow on task property can be changed for the kind and current state of the object.
        Specified by:
        isSupportsFollowOnTasksUpdateable in interface Task
      • setSuspended

        public void setSuspended(boolean suspendedState)
        Sets the property suspended.
        Parameters:
        suspendedState -
      • setType

        public void setType(java.lang.String arg0)
        Sets the property type.
        Specified by:
        setType in interface Task
        Parameters:
        arg0 - The type of the task instance.
        See Also:
        Task.setType(java.lang.String)
      • isTypeUpdateable

        public boolean isTypeUpdateable()
        Signals whether the type property can be changed for the kind and current state of the object.
        Specified by:
        isTypeUpdateable in interface Task
      • isSupportsAutomaticClaim

        public boolean isSupportsAutomaticClaim()
        Returns the property supportsAutomaticClaim.
        Returns:
        supportsAutomaticClaim
        See Also:
        Task.supportsAutomaticClaim()
      • isSupportsDelegation

        public boolean isSupportsDelegation()
        Returns the property supportsDelegation.
        Returns:
        supportsDelegation
        See Also:
        Task.supportsDelegation()
      • isSupportsSubTasks

        public boolean isSupportsSubTasks()
        Returns the property supportsSubTasks.
        Returns:
        supportsSubTasks
        See Also:
        Task.supportsSubTasks()
      • isSupportsFollowOnTasks

        public boolean isSupportsFollowOnTasks()
        Returns the property supportsFollowOnTasks.
        Returns:
        supportsFollowOnTasks
        See Also:
        Task.supportsFollowOnTasks()
      • isSupportsClaimIfSuspended

        public boolean isSupportsClaimIfSuspended()
        Returns the property supportsClaimIfSuspended.
        Returns:
        supportsClaimIfSuspended
        See Also:
        Task.supportsClaimIfSuspended()
      • isSupportsClaimIfSuspendedUpdateable

        public boolean isSupportsClaimIfSuspendedUpdateable()
        Signals whether the supports claim suspended property can be changed for the kind and current state of the object.
        Specified by:
        isSupportsClaimIfSuspendedUpdateable in interface Task
      • getValidFromTime

        public java.util.Calendar getValidFromTime()
        Returns the validFromTime property.
        See Also:
        com.ibm.task.api.TaskTemplateData#getValidFromTime()
      • getSnapshotID

        public java.lang.String getSnapshotID()
        Returns the snapshotID property.
        See Also:
        com.ibm.task.api.TaskTemplateData#getSnapshotID()
      • getSnapshotName

        public java.lang.String getSnapshotName()
        Returns the snapshotName property.
        See Also:
        com.ibm.task.api.TaskTemplateData#getSnapshotName()
      • getTrackName

        public java.lang.String getTrackName()
        Returns the trackName property.
        See Also:
        com.ibm.task.api.TaskTemplateData#getTrackName()
      • getProcessAppName

        public java.lang.String getProcessAppName()
        Returns the processAppName property.
        See Also:
        com.ibm.task.api.TaskTemplateData#getProcessAppName()
      • getProcessAppAcronym

        public java.lang.String getProcessAppAcronym()
        Returns the processAppAcronym property.
        See Also:
        com.ibm.task.api.TaskTemplateData#getProcessAppAcronym()
      • getToolkitSnapshotID

        public java.lang.String getToolkitSnapshotID()
        Returns the toolkitSnapshotID property.
        See Also:
        com.ibm.task.api.TaskTemplateData#getToolkitSnapshotID()
      • getToolkitSnapshotName

        public java.lang.String getToolkitSnapshotName()
        Returns the toolkitSnapshotName property.
        See Also:
        com.ibm.task.api.TaskTemplateData#getToolkitSnapshotName()
      • getToolkitName

        public java.lang.String getToolkitName()
        Returns the toolkitName property.
        See Also:
        com.ibm.task.api.TaskTemplateData#getToolkitName()
      • getToolkitAcronym

        public java.lang.String getToolkitAcronym()
        Returns the toolkitAcronym property.
        See Also:
        com.ibm.task.api.TaskTemplateData#getToolkitAcronym()
      • getTopLevelToolkitName

        public java.lang.String getTopLevelToolkitName()
        Returns the topLevelToolkitName property.
        See Also:
        com.ibm.task.api.TaskTemplateData#getTopLevelToolkitName()
      • getTopLevelToolkitAcronym

        public java.lang.String getTopLevelToolkitAcronym()
        Returns the topLevelToolkitAcronym property.
        See Also:
        com.ibm.task.api.TaskTemplateData#getTopLevelToolkitAcronym()
      • getApplicationName

        public java.lang.String getApplicationName()
        Description copied from interface: Task
        Returns the name of the application the task is part of.
        Specified by:
        getApplicationName in interface Task
      • setApplicationName

        public void setApplicationName(java.lang.String newApplicationName)
      • getHTMConnection

        protected HTMConnection getHTMConnection()
        Returns:
        Returns the connection.
      • setHTMConnection

        protected void setHTMConnection(HTMConnection connection)
        Parameters:
        connection - The connection to set.
      • setOriginal

        protected void setOriginal(Task task)
        Parameters:
        task - ???
IBM Business Process ManagerTM
Release 8