com.ibm.task.clientmodel.bean
Class TaskInstanceBean

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

public class TaskInstanceBean
extends java.lang.Object
implements com.ibm.task.api.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 that is necessary to get the job done. For example, a task that is associated to 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 Business Process Choreographer API, all properties are loaded. If the bean is instantiated from a query only the following properties are going to be loaded from the query result set:

If the property was not found in the query result set, the property will remain 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 may be null because converters are optional.

See Also:
Task, QueryResultSet, Serialized Form

Field Summary
static java.lang.String ACTIVATIONTIME_PROPERTY
          Use the property name to determine labels and converters for the property activationTime.
static java.lang.String BUSINESSRELEVANT_PROPERTY
          Use the property name to determine labels and converters for the property BusinessRelevant.
static java.lang.String COMPLETIONTIME_PROPERTY
          Use the property name to determine labels and converters for the property completionTime.
static java.lang.String CONTAINMENTCONTEXTID_PROPERTY
          Use the property name to determine labels and converters for the property containmentContextID.
static java.lang.String COPYRIGHT
          (C) Copyright IBM Corporation 2005.
static java.lang.String CUSTOMPROPERTY_PROPERTY
          Use the property name to determine labels and converters for the property customProperty.
static java.lang.String DESCRIPTION_PROPERTY
          Use the property name to determine labels and converters for the property description.
static java.lang.String DISPLAYNAME_PROPERTY
          Use the property name to determine labels and converters for the property displayName.
static java.lang.String ESCALATED_PROPERTY
          Use the property name to determine labels and converters for the property escalated.
static java.lang.String EXPIRATIONTIME_PROPERTY
          Use the property name to determine labels and converters for the property expirationTime.
static java.lang.String FIRSTACTIVATIONTIME_PROPERTY
          Use the property name to determine labels and converters for the property firstActivationTime.
static java.lang.String ID_PROPERTY
          Use the property name to determine labels and converters for the property ID.
static java.lang.String INPUTMESSAGETYPENAME_PROPERTY
          Use the property name to determine labels and converters for the property inputMessageTypeName.
static java.lang.String KIND_PROPERTY
          Use the property name to determine labels and converters for the property kind.
static java.lang.String LASTMODIFICATIONTIME_PROPERTY
          Use the property name to determine labels and converters for the property lastModificationTime.
static java.lang.String LASTSTATECHANGETIME_PROPERTY
          Use the property name to determine labels and converters for the property lastStateChangeTime.
static java.lang.String NAME_PROPERTY
          Use the property name to determine labels and converters for the property name.
static java.lang.String ORIGINATOR_PROPERTY
          Use the property name to determine labels and converters for the property originator.
static java.lang.String OUTPUTMESSAGETYPENAME_PROPERTY
          Use the property name to determine labels and converters for the property outputMessageTypeName.
static java.lang.String OWNER_PROPERTY
          Use the property name to determine labels and converters for the property owner.
static java.lang.String PARENTCONTEXTID_PROPERTY
          Use the property name to determine labels and converters for the property parentContextID.
static java.lang.String STARTTIME_PROPERTY
          Use the property name to determine labels and converters for the property startTime.
static java.lang.String STATE_PROPERTY
          Use the property name to determine labels and converters for the property state.
static java.lang.String SUSPENDED_PROPERTY
          Use the property name to determine labels and converters for the property suspended.
 
Fields inherited from interface com.ibm.task.api.Task
AUTH_NONE, AUTH_READER, KIND_ADMINISTRATIVE, KIND_HUMAN, KIND_ORIGINATING, KIND_PARTICIPATING, KIND_WPC_STAFF_ACTIVITY, STATE_CLAIMED, STATE_EXPIRED, STATE_FAILED, STATE_FAILING, STATE_FINISHED, STATE_FORWARDED, STATE_INACTIVE, STATE_PROCESSING_UNDO, STATE_READY, STATE_RUNNING, STATE_SKIPPED, STATE_STOPPED, STATE_TERMINATED, STATE_TERMINATING, STATE_WAITING
 
Constructor Summary
TaskInstanceBean(com.ibm.task.api.QueryResultSet resultSet, HTMConnection htmConnection)
          Constructs a new TaskInstanceBean from a QueryResultSet.
TaskInstanceBean(com.ibm.task.api.Task task, HTMConnection htmConnection)
          Constructs a TaskInstanceBean from an original Task object.
 
Method Summary
 MessageWrapper createOutputMessageWrapper()
          Creates an initial empty output message.
 java.util.Calendar getActivationTime()
          Returns the property activationTime.
 com.ibm.task.api.ACOID getApplicationDefaultsID()
          Returns the property applicationDefaultsID.
 java.lang.String getCalendarName()
          Returns the property calendarName.
 java.util.Calendar getCompletionTime()
          Returns the property completionTime.
 com.ibm.bpe.api.OID getContainmentContextID()
          Returns the property containmentContextID.
 int getContextAuthorizationOfOwner()
          Returns the property contextAuthorizationOfOwner.
static SimpleConverter getConverter(java.lang.String propertyName)
          Returns the default converter for a given property.
 com.ibm.bpc.clientcore.util.LocalisedString getDescription()
          Returns the localised description.
 java.lang.String getDescription(java.util.Locale locale)
          Returns the property description.
 com.ibm.bpc.clientcore.util.LocalisedString getDisplayName()
          Returns the localised display name.
 java.lang.String getDisplayName(java.util.Locale locale)
          Returns the property displayName.
 java.util.Calendar getDueTime()
          Returns the property dueTime.
 java.lang.String getDurationUntilDeleted()
          Returns the property durationUntilDeleted.
 java.lang.String getDurationUntilDue()
          Returns the property durationUntilDue.
 java.lang.String getDurationUntilExpires()
          Returns the property durationUntilExpires.
 java.lang.String getEventHandlerName()
          Returns the property eventHandlerName.
 java.util.Calendar getExpirationTime()
          Returns the property expirationTime.
 MessageWrapper getFaultMessageWrapper()
          Retrieves the fault message.
 java.util.Calendar getFirstActivationTime()
          Returns the property firstActivationTime.
 com.ibm.task.api.TKIID getFollowOnTaskID()
          Returns the property followOnTaskID.
 com.ibm.task.api.TKIID getID()
          Returns the property ID.
 java.lang.String getInputMessageTypeName()
          Returns the property inputMessageTypeName.
 MessageWrapper getInputMessageWrapper()
          Retrieves the input message.
 java.lang.String getJNDINameOfCalendar()
          Returns the property JNDINameOfCalendar.
 java.lang.String getJNDINameOfStaffPluginProvider()
          Returns the property JNDINameOfStaffPluginProvider.
 int getKind()
          Returns the property kind.
static java.lang.String getLabel(java.lang.String propertyName)
          Returns the resource bundle key for a property
static java.lang.String getLabel(java.lang.String propertyName, java.util.Locale locale)
          Returns the label for a property from the resource bundle.
 java.util.Calendar getLastModificationTime()
          Returns the property lastModificationTime.
 java.util.Calendar getLastStateChangeTime()
          Returns the property lastStateChangeTime.
 java.util.List getLocalesOfDescriptions()
          Returns the property localesOfDescriptions.
 java.util.List getLocalesOfDisplayNames()
          Returns the property localesOfDisplayNames.
 java.lang.String getName()
          Returns the property name.
 java.lang.String getNamespace()
          Returns the property namespace.
 java.lang.String getOriginator()
          Returns the property originator.
 java.lang.String getOutputMessageTypeName()
          Returns the property outputMessageTypeName.
 MessageWrapper getOutputMessageWrapper()
          Retrieves the output message.
 java.lang.String getOwner()
          Returns the property owner.
 com.ibm.bpe.api.OID getParentContextID()
          Returns the property parentContextID.
 java.lang.Integer getPriority()
          Returns the property priority.
 java.lang.String getStarter()
          Returns the property starter.
 java.util.Calendar getStartTime()
          Returns the property startTime.
 int getState()
          Returns the property state.
 com.ibm.task.api.TKTID getTaskTemplateID()
          Returns the property taskTemplateID.
 java.lang.String getTaskTemplateName()
          Returns the property taskTemplateName.
 com.ibm.task.api.TKIID getTopLevelTaskID()
          Returns the property topLevelTaskID.
 java.lang.String getType()
          Returns the property type.
 boolean isAdHoc()
          Returns the property adHoc.
 boolean isBusinessRelevant()
          Returns the property businessRelevant.
 boolean isEscalated()
          Returns the property escalated.
 boolean isInline()
          Returns the property inline.
 boolean isSuspended()
          Returns the property suspended.
static boolean isValid(java.lang.String propertyName)
          Checks if the property is valid.
 boolean isWaitingForSubTask()
          Returns the property waitingForSubTask.
 void setBusinessRelevance(boolean arg0)
          Sets the property businessRelevance.
 void setContextAuthorizationOfOwner(int arg0)
          Sets the property contextAuthorizationOfOwner.
 void setDescription(java.lang.String arg0, java.util.Locale arg1)
          Sets the property description.
 void setDisplayName(java.lang.String arg0, java.util.Locale arg1)
          Sets the property displayName.
 void setDurationUntilDeleted(java.lang.String arg0)
          Sets the property durationUntilDeleted.
 void setDurationUntilDue(java.lang.String arg0)
          Sets the property durationUntilDue.
 void setEscalated(boolean escalatedState)
          Sets the property escalated.
 void setEventHandlerName(java.lang.String arg0)
          Sets the property eventHandlerName.
 void setName(java.lang.String arg0)
          Sets the property name.
 void setNamespace(java.lang.String arg0)
          Sets the property namespace.
 void setParentContextID(com.ibm.bpe.api.OID arg0)
          Sets the property parentContextID.
 void setPriority(java.lang.Integer arg0)
          Sets the property priority.
 void setState(java.lang.Integer newState)
          Sets the property state.
 void setSupportsClaimIfSuspended(boolean arg0)
          Sets the property supportsClaimIfSuspended.
 void setSupportsDelegation(boolean arg0)
          Sets the property supportsDelegation.
 void setSupportsSubTasks(boolean arg0)
          Sets the property supportsSubTasks.
 void setSuspended(boolean suspendedState)
          Sets the property suspended.
 void setType(java.lang.String arg0)
          Sets the property type.
 boolean supportsAutomaticClaim()
          Returns the property supportsAutomaticClaim.
 boolean supportsClaimIfSuspended()
          Returns the property supportsClaimIfSuspended.
 boolean supportsDelegation()
          Returns the property supportsDelegation.
 boolean supportsSubTasks()
          Returns the property supportsSubTasks.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
(C) Copyright IBM Corporation 2005.

See Also:
Constant Field Values

ACTIVATIONTIME_PROPERTY

public static java.lang.String ACTIVATIONTIME_PROPERTY
Use the property name to determine labels and converters for the property activationTime.


BUSINESSRELEVANT_PROPERTY

public static java.lang.String BUSINESSRELEVANT_PROPERTY
Use the property name to determine labels and converters for the property BusinessRelevant.


COMPLETIONTIME_PROPERTY

public static java.lang.String COMPLETIONTIME_PROPERTY
Use the property name to determine labels and converters for the property completionTime.


CONTAINMENTCONTEXTID_PROPERTY

public static java.lang.String CONTAINMENTCONTEXTID_PROPERTY
Use the property name to determine labels and converters for the property containmentContextID.


CUSTOMPROPERTY_PROPERTY

public static java.lang.String CUSTOMPROPERTY_PROPERTY
Use the property name to determine labels and converters for the property customProperty.


DESCRIPTION_PROPERTY

public static java.lang.String DESCRIPTION_PROPERTY
Use the property name to determine labels and converters for the property description.


DISPLAYNAME_PROPERTY

public static java.lang.String DISPLAYNAME_PROPERTY
Use the property name to determine labels and converters for the property displayName.


ESCALATED_PROPERTY

public static java.lang.String ESCALATED_PROPERTY
Use the property name to determine labels and converters for the property escalated.


EXPIRATIONTIME_PROPERTY

public static java.lang.String EXPIRATIONTIME_PROPERTY
Use the property name to determine labels and converters for the property expirationTime.


FIRSTACTIVATIONTIME_PROPERTY

public static java.lang.String FIRSTACTIVATIONTIME_PROPERTY
Use the property name to determine labels and converters for the property firstActivationTime.


ID_PROPERTY

public static java.lang.String ID_PROPERTY
Use the property name to determine labels and converters for the property ID.


INPUTMESSAGETYPENAME_PROPERTY

public static java.lang.String INPUTMESSAGETYPENAME_PROPERTY
Use the property name to determine labels and converters for the property inputMessageTypeName.


KIND_PROPERTY

public static java.lang.String KIND_PROPERTY
Use the property name to determine labels and converters for the property kind.


LASTMODIFICATIONTIME_PROPERTY

public static java.lang.String LASTMODIFICATIONTIME_PROPERTY
Use the property name to determine labels and converters for the property lastModificationTime.


LASTSTATECHANGETIME_PROPERTY

public static java.lang.String LASTSTATECHANGETIME_PROPERTY
Use the property name to determine labels and converters for the property lastStateChangeTime.


NAME_PROPERTY

public static java.lang.String NAME_PROPERTY
Use the property name to determine labels and converters for the property name.


ORIGINATOR_PROPERTY

public static java.lang.String ORIGINATOR_PROPERTY
Use the property name to determine labels and converters for the property originator.


OUTPUTMESSAGETYPENAME_PROPERTY

public static java.lang.String OUTPUTMESSAGETYPENAME_PROPERTY
Use the property name to determine labels and converters for the property outputMessageTypeName.


OWNER_PROPERTY

public static java.lang.String OWNER_PROPERTY
Use the property name to determine labels and converters for the property owner.


PARENTCONTEXTID_PROPERTY

public static java.lang.String PARENTCONTEXTID_PROPERTY
Use the property name to determine labels and converters for the property parentContextID.


STARTTIME_PROPERTY

public static java.lang.String STARTTIME_PROPERTY
Use the property name to determine labels and converters for the property startTime.


STATE_PROPERTY

public static java.lang.String STATE_PROPERTY
Use the property name to determine labels and converters for the property state.


SUSPENDED_PROPERTY

public static java.lang.String SUSPENDED_PROPERTY
Use the property name to determine labels and converters for the property suspended.

Constructor Detail

TaskInstanceBean

public TaskInstanceBean(com.ibm.task.api.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(com.ibm.task.api.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.
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.

getActivationTime

public java.util.Calendar getActivationTime()
Returns the property activationTime.

Specified by:
getActivationTime in interface com.ibm.task.api.Task
See Also:
Task.getActivationTime()

getApplicationDefaultsID

public com.ibm.task.api.ACOID getApplicationDefaultsID()
Returns the property applicationDefaultsID.

Specified by:
getApplicationDefaultsID in interface com.ibm.task.api.Task
See Also:
Task.getApplicationDefaultsID()

getCalendarName

public java.lang.String getCalendarName()
Returns the property calendarName.

Specified by:
getCalendarName in interface com.ibm.task.api.Task
See Also:
Task.getCalendarName()

getCompletionTime

public java.util.Calendar getCompletionTime()
Returns the property completionTime.

Specified by:
getCompletionTime in interface com.ibm.task.api.Task
See Also:
Task.getCompletionTime()

getContainmentContextID

public com.ibm.bpe.api.OID getContainmentContextID()
Returns the property containmentContextID.

Specified by:
getContainmentContextID in interface com.ibm.task.api.Task
See Also:
Task.getContainmentContextID()

getContextAuthorizationOfOwner

public int getContextAuthorizationOfOwner()
Returns the property contextAuthorizationOfOwner.

Specified by:
getContextAuthorizationOfOwner in interface com.ibm.task.api.Task
See Also:
Task.getContextAuthorizationOfOwner()

getDescription

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

Returns:
The localised description.

getDisplayName

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

Returns:
The localised display name.

getDescription

public java.lang.String getDescription(java.util.Locale locale)
Returns the property description.

Specified by:
getDescription in interface com.ibm.task.api.Task
See Also:
Task.getDescription(java.util.Locale)

getDisplayName

public java.lang.String getDisplayName(java.util.Locale locale)
Returns the property displayName.

Specified by:
getDisplayName in interface com.ibm.task.api.Task
See Also:
Task.getDisplayName(java.util.Locale)

getDueTime

public java.util.Calendar getDueTime()
Returns the property dueTime.

Specified by:
getDueTime in interface com.ibm.task.api.Task
See Also:
Task.getDueTime()

getDurationUntilDeleted

public java.lang.String getDurationUntilDeleted()
Returns the property durationUntilDeleted.

Specified by:
getDurationUntilDeleted in interface com.ibm.task.api.Task
See Also:
Task.getDurationUntilDeleted()

getDurationUntilDue

public java.lang.String getDurationUntilDue()
Returns the property durationUntilDue.

Specified by:
getDurationUntilDue in interface com.ibm.task.api.Task
See Also:
Task.getDurationUntilDue()

getDurationUntilExpires

public java.lang.String getDurationUntilExpires()
Returns the property durationUntilExpires.

Specified by:
getDurationUntilExpires in interface com.ibm.task.api.Task
See Also:
Task.getDurationUntilExpires()

getEventHandlerName

public java.lang.String getEventHandlerName()
Returns the property eventHandlerName.

Specified by:
getEventHandlerName in interface com.ibm.task.api.Task
See Also:
Task.getEventHandlerName()

getExpirationTime

public java.util.Calendar getExpirationTime()
Returns the property expirationTime.

Specified by:
getExpirationTime in interface com.ibm.task.api.Task
See Also:
Task.getExpirationTime()

getFirstActivationTime

public java.util.Calendar getFirstActivationTime()
Returns the property firstActivationTime.

Specified by:
getFirstActivationTime in interface com.ibm.task.api.Task
See Also:
Task.getFirstActivationTime()

getFollowOnTaskID

public com.ibm.task.api.TKIID getFollowOnTaskID()
Returns the property followOnTaskID.

Specified by:
getFollowOnTaskID in interface com.ibm.task.api.Task
See Also:
Task.getFollowOnTaskID()

getID

public com.ibm.task.api.TKIID getID()
Returns the property ID.

Specified by:
getID in interface com.ibm.task.api.Task
See Also:
Task.getID()

getInputMessageTypeName

public java.lang.String getInputMessageTypeName()
Returns the property inputMessageTypeName.

Specified by:
getInputMessageTypeName in interface com.ibm.task.api.Task
See Also:
Task.getInputMessageTypeName()

getJNDINameOfCalendar

public java.lang.String getJNDINameOfCalendar()
Returns the property JNDINameOfCalendar.

Specified by:
getJNDINameOfCalendar in interface com.ibm.task.api.Task
See Also:
Task.getJNDINameOfCalendar()

getJNDINameOfStaffPluginProvider

public java.lang.String getJNDINameOfStaffPluginProvider()
Returns the property JNDINameOfStaffPluginProvider.

Specified by:
getJNDINameOfStaffPluginProvider in interface com.ibm.task.api.Task
See Also:
Task.getJNDINameOfStaffPluginProvider()

getKind

public int getKind()
Returns the property kind.

Specified by:
getKind in interface com.ibm.task.api.Task
See Also:
Task.getKind()

getLastModificationTime

public java.util.Calendar getLastModificationTime()
Returns the property lastModificationTime.

Specified by:
getLastModificationTime in interface com.ibm.task.api.Task
See Also:
Task.getLastModificationTime()

getLastStateChangeTime

public java.util.Calendar getLastStateChangeTime()
Returns the property lastStateChangeTime.

Specified by:
getLastStateChangeTime in interface com.ibm.task.api.Task
See Also:
Task.getLastStateChangeTime()

getLocalesOfDescriptions

public java.util.List getLocalesOfDescriptions()
Returns the property localesOfDescriptions.

Specified by:
getLocalesOfDescriptions in interface com.ibm.task.api.Task
See Also:
Task.getLocalesOfDescriptions()

getLocalesOfDisplayNames

public java.util.List getLocalesOfDisplayNames()
Returns the property localesOfDisplayNames.

Specified by:
getLocalesOfDisplayNames in interface com.ibm.task.api.Task
See Also:
Task.getLocalesOfDisplayNames()

getName

public java.lang.String getName()
Returns the property name.

Specified by:
getName in interface com.ibm.task.api.Task
See Also:
Task.getName()

getNamespace

public java.lang.String getNamespace()
Returns the property namespace.

Specified by:
getNamespace in interface com.ibm.task.api.Task
See Also:
Task.getNamespace()

getOriginator

public java.lang.String getOriginator()
Returns the property originator.

Specified by:
getOriginator in interface com.ibm.task.api.Task
See Also:
Task.getOriginator()

getOutputMessageTypeName

public java.lang.String getOutputMessageTypeName()
Returns the property outputMessageTypeName.

Specified by:
getOutputMessageTypeName in interface com.ibm.task.api.Task
See Also:
Task.getOutputMessageTypeName()

getOwner

public java.lang.String getOwner()
Returns the property owner.

Specified by:
getOwner in interface com.ibm.task.api.Task
See Also:
Task.getOwner()

getParentContextID

public com.ibm.bpe.api.OID getParentContextID()
Returns the property parentContextID.

Specified by:
getParentContextID in interface com.ibm.task.api.Task
See Also:
Task.getParentContextID()

getPriority

public java.lang.Integer getPriority()
Returns the property priority.

Specified by:
getPriority in interface com.ibm.task.api.Task
See Also:
Task.getPriority()

getStarter

public java.lang.String getStarter()
Returns the property starter.

Specified by:
getStarter in interface com.ibm.task.api.Task
See Also:
Task.getStarter()

getStartTime

public java.util.Calendar getStartTime()
Returns the property startTime.

Specified by:
getStartTime in interface com.ibm.task.api.Task
See Also:
Task.getStartTime()

getState

public int getState()
Returns the property state.

Specified by:
getState in interface com.ibm.task.api.Task
See Also:
Task.getState()

getTaskTemplateID

public com.ibm.task.api.TKTID getTaskTemplateID()
Returns the property taskTemplateID.

Specified by:
getTaskTemplateID in interface com.ibm.task.api.Task
See Also:
Task.getTaskTemplateID()

getTaskTemplateName

public java.lang.String getTaskTemplateName()
Returns the property taskTemplateName. TODO: check

Specified by:
getTaskTemplateName in interface com.ibm.task.api.Task

getTopLevelTaskID

public com.ibm.task.api.TKIID getTopLevelTaskID()
Returns the property topLevelTaskID.

Specified by:
getTopLevelTaskID in interface com.ibm.task.api.Task
See Also:
Task.getTopLevelTaskID()

getType

public java.lang.String getType()
Returns the property type.

Specified by:
getType in interface com.ibm.task.api.Task
See Also:
Task.getType()

isAdHoc

public boolean isAdHoc()
Returns the property adHoc.

Specified by:
isAdHoc in interface com.ibm.task.api.Task
See Also:
Task.isAdHoc()

isInline

public boolean isInline()
Returns the property inline.

Specified by:
isInline in interface com.ibm.task.api.Task
See Also:
Task.isInline()

isBusinessRelevant

public boolean isBusinessRelevant()
Returns the property businessRelevant.

Specified by:
isBusinessRelevant in interface com.ibm.task.api.Task
See Also:
Task.isBusinessRelevant()

isEscalated

public boolean isEscalated()
Returns the property escalated.

Specified by:
isEscalated in interface com.ibm.task.api.Task
See Also:
Task.isEscalated()

setEscalated

public void setEscalated(boolean escalatedState)
Sets the property escalated.

Parameters:
escalatedState -

isSuspended

public boolean isSuspended()
Returns the property suspended.

Specified by:
isSuspended in interface com.ibm.task.api.Task
See Also:
Task.isSuspended()

setSuspended

public void setSuspended(boolean suspendedState)
Sets the property suspended.


isWaitingForSubTask

public boolean isWaitingForSubTask()
Returns the property waitingForSubTask.

Specified by:
isWaitingForSubTask in interface com.ibm.task.api.Task
See Also:
Task.isWaitingForSubTask()

setBusinessRelevance

public void setBusinessRelevance(boolean arg0)
Sets the property businessRelevance.

Specified by:
setBusinessRelevance in interface com.ibm.task.api.Task
See Also:
Task.setBusinessRelevance(boolean)

setContextAuthorizationOfOwner

public void setContextAuthorizationOfOwner(int arg0)
Sets the property contextAuthorizationOfOwner.

Specified by:
setContextAuthorizationOfOwner in interface com.ibm.task.api.Task
See Also:
Task.setContextAuthorizationOfOwner(int)

setDescription

public void setDescription(java.lang.String arg0,
                           java.util.Locale arg1)
Sets the property description.

Specified by:
setDescription in interface com.ibm.task.api.Task
See Also:
Task.setDescription(java.lang.String, java.util.Locale)

setDisplayName

public void setDisplayName(java.lang.String arg0,
                           java.util.Locale arg1)
Sets the property displayName.

Specified by:
setDisplayName in interface com.ibm.task.api.Task
See Also:
Task.setDisplayName(java.lang.String, java.util.Locale)

setDurationUntilDeleted

public void setDurationUntilDeleted(java.lang.String arg0)
Sets the property durationUntilDeleted.

Specified by:
setDurationUntilDeleted in interface com.ibm.task.api.Task
See Also:
Task.setDurationUntilDeleted(java.lang.String)

setDurationUntilDue

public void setDurationUntilDue(java.lang.String arg0)
Sets the property durationUntilDue.

Specified by:
setDurationUntilDue in interface com.ibm.task.api.Task
See Also:
Task.setDurationUntilDue(java.lang.String)

setEventHandlerName

public void setEventHandlerName(java.lang.String arg0)
Sets the property eventHandlerName.

Specified by:
setEventHandlerName in interface com.ibm.task.api.Task
See Also:
Task.setEventHandlerName(java.lang.String)

setName

public void setName(java.lang.String arg0)
Sets the property name.

Specified by:
setName in interface com.ibm.task.api.Task
See Also:
Task.setName(java.lang.String)

setNamespace

public void setNamespace(java.lang.String arg0)
Sets the property namespace.

Specified by:
setNamespace in interface com.ibm.task.api.Task
See Also:
Task.setNamespace(java.lang.String)

setParentContextID

public void setParentContextID(com.ibm.bpe.api.OID arg0)
Sets the property parentContextID.

Specified by:
setParentContextID in interface com.ibm.task.api.Task
See Also:
Task.setParentContextID(com.ibm.bpe.api.OID)

setPriority

public void setPriority(java.lang.Integer arg0)
Sets the property priority.

Specified by:
setPriority in interface com.ibm.task.api.Task
See Also:
Task.setPriority(java.lang.Integer)

setState

public void setState(java.lang.Integer newState)
Sets the property state.


setSupportsClaimIfSuspended

public void setSupportsClaimIfSuspended(boolean arg0)
Sets the property supportsClaimIfSuspended.

Specified by:
setSupportsClaimIfSuspended in interface com.ibm.task.api.Task
See Also:
Task.setSupportsClaimIfSuspended(boolean)

setSupportsDelegation

public void setSupportsDelegation(boolean arg0)
Sets the property supportsDelegation.

Specified by:
setSupportsDelegation in interface com.ibm.task.api.Task
See Also:
Task.setSupportsDelegation(boolean)

setSupportsSubTasks

public void setSupportsSubTasks(boolean arg0)
Sets the property supportsSubTasks.

Specified by:
setSupportsSubTasks in interface com.ibm.task.api.Task
See Also:
Task.setSupportsSubTasks(boolean)

setType

public void setType(java.lang.String arg0)
Sets the property type.

Specified by:
setType in interface com.ibm.task.api.Task
See Also:
Task.setType(java.lang.String)

supportsAutomaticClaim

public boolean supportsAutomaticClaim()
Returns the property supportsAutomaticClaim.

Specified by:
supportsAutomaticClaim in interface com.ibm.task.api.Task
See Also:
Task.supportsAutomaticClaim()

supportsClaimIfSuspended

public boolean supportsClaimIfSuspended()
Returns the property supportsClaimIfSuspended.

Specified by:
supportsClaimIfSuspended in interface com.ibm.task.api.Task
See Also:
Task.supportsClaimIfSuspended()

supportsDelegation

public boolean supportsDelegation()
Returns the property supportsDelegation.

Specified by:
supportsDelegation in interface com.ibm.task.api.Task
See Also:
Task.supportsDelegation()

supportsSubTasks

public boolean supportsSubTasks()
Returns the property supportsSubTasks.

Specified by:
supportsSubTasks in interface com.ibm.task.api.Task
See Also:
Task.supportsSubTasks()

getInputMessageWrapper

public MessageWrapper getInputMessageWrapper()
                                      throws ClientException
Retrieves the input message. If web client settings are available the context root and the URL are retrieved.

Returns:
The wrapped message and web client settings.
Throws:
ClientException
See Also:
HumanTaskManagerService.getInputMessage(com.ibm.task.api.TKIID)

getOutputMessageWrapper

public MessageWrapper getOutputMessageWrapper()
                                       throws ClientException
Retrieves the output message. If web client settings are available the context root and the URL are retrieved.

Returns:
The wrapped message and web client settings.
Throws:
ClientException
See Also:
HumanTaskManagerService

createOutputMessageWrapper

public MessageWrapper createOutputMessageWrapper()
                                          throws ClientException
Creates an initial empty output message.

Returns:
The wrapped message.
Throws:
ClientException

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