IBM BPM API for Web Service Clients v8.0.0

com.lombardisoftware.webapi
Class Task

java.lang.Object
  extended by com.lombardisoftware.webapi.Task
All Implemented Interfaces:
java.io.Serializable

public class Task
extends java.lang.Object
implements java.io.Serializable

A task is contain information about an instance of an activity and is typically associated with a process instance. Tasks may also be used for special purposes such as alerts and help requests. Check the documentation for the operation that returns a Task to see what elements are available since a Task may be partially loaded (usually just the Id element is present and all the other element are not set or are nil in that case).

See Also:
Serialized Form

Constructor Summary
Task()
           
Task(java.lang.String activityName, java.lang.String assignedToRole, java.lang.String assignedToUser, InfoPathFormAttachment attachedInfoPathForm, BusinessData businessData, java.lang.String closedBy, java.util.Calendar closedDate, java.util.Calendar dueDate, long id, java.lang.String narrative, java.lang.String participant, java.lang.String participantDisplayName, java.lang.String priority, java.lang.Integer priorityRanking, ProcessInstance processInstance, java.util.Calendar readDate, java.util.Calendar receivedDate, java.util.Calendar sentDate, java.lang.String serverAddress, Service service, java.lang.String status, java.lang.String subject, ActionPermission[] actionPermissions, java.lang.String sharepointDiscussionUrl, ExternalActivityAttachment attachedExternalActivity)
           
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 ActionPermission[] getActionPermissions()
          Gets the actionPermissions value for this Task.
 java.lang.String getActivityName()
          Gets the activityName value for this Task.
 java.lang.String getAssignedToRole()
          Gets the assignedToRole value for this Task.
 java.lang.String getAssignedToUser()
          Gets the assignedToUser value for this Task.
 ExternalActivityAttachment getAttachedExternalActivity()
          Gets the attachedExternalActivity value for this Task.
 InfoPathFormAttachment getAttachedInfoPathForm()
          Gets the attachedInfoPathForm value for this Task.
 BusinessData getBusinessData()
          Gets the businessData value for this Task.
 java.lang.String getClosedBy()
          Gets the closedBy value for this Task.
 java.util.Calendar getClosedDate()
          Gets the closedDate value for this Task.
static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
          Get Custom Deserializer
 java.util.Calendar getDueDate()
          Gets the dueDate value for this Task.
 long getId()
          Gets the id value for this Task.
 java.lang.String getNarrative()
          Gets the narrative value for this Task.
 java.lang.String getParticipant()
          Gets the participant value for this Task.
 java.lang.String getParticipantDisplayName()
          Gets the participantDisplayName value for this Task.
 java.lang.String getPriority()
          Gets the priority value for this Task.
 java.lang.Integer getPriorityRanking()
          Gets the priorityRanking value for this Task.
 ProcessInstance getProcessInstance()
          Gets the processInstance value for this Task.
 java.util.Calendar getReadDate()
          Gets the readDate value for this Task.
 java.util.Calendar getReceivedDate()
          Gets the receivedDate value for this Task.
 java.util.Calendar getSentDate()
          Gets the sentDate value for this Task.
static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
          Get Custom Serializer
 java.lang.String getServerAddress()
          Gets the serverAddress value for this Task.
 Service getService()
          Gets the service value for this Task.
 java.lang.String getSharepointDiscussionUrl()
          Gets the sharepointDiscussionUrl value for this Task.
 java.lang.String getStatus()
          Gets the status value for this Task.
 java.lang.String getSubject()
          Gets the subject value for this Task.
static org.apache.axis.description.TypeDesc getTypeDesc()
          Return type metadata object
 int hashCode()
           
 void setActionPermissions(ActionPermission[] actionPermissions)
          Sets the actionPermissions value for this Task.
 void setActivityName(java.lang.String activityName)
          Sets the activityName value for this Task.
 void setAssignedToRole(java.lang.String assignedToRole)
          Sets the assignedToRole value for this Task.
 void setAssignedToUser(java.lang.String assignedToUser)
          Sets the assignedToUser value for this Task.
 void setAttachedExternalActivity(ExternalActivityAttachment attachedExternalActivity)
          Sets the attachedExternalActivity value for this Task.
 void setAttachedInfoPathForm(InfoPathFormAttachment attachedInfoPathForm)
          Sets the attachedInfoPathForm value for this Task.
 void setBusinessData(BusinessData businessData)
          Sets the businessData value for this Task.
 void setClosedBy(java.lang.String closedBy)
          Sets the closedBy value for this Task.
 void setClosedDate(java.util.Calendar closedDate)
          Sets the closedDate value for this Task.
 void setDueDate(java.util.Calendar dueDate)
          Sets the dueDate value for this Task.
 void setId(long id)
          Sets the id value for this Task.
 void setNarrative(java.lang.String narrative)
          Sets the narrative value for this Task.
 void setParticipant(java.lang.String participant)
          Sets the participant value for this Task.
 void setParticipantDisplayName(java.lang.String participantDisplayName)
          Sets the participantDisplayName value for this Task.
 void setPriority(java.lang.String priority)
          Sets the priority value for this Task.
 void setPriorityRanking(java.lang.Integer priorityRanking)
          Sets the priorityRanking value for this Task.
 void setProcessInstance(ProcessInstance processInstance)
          Sets the processInstance value for this Task.
 void setReadDate(java.util.Calendar readDate)
          Sets the readDate value for this Task.
 void setReceivedDate(java.util.Calendar receivedDate)
          Sets the receivedDate value for this Task.
 void setSentDate(java.util.Calendar sentDate)
          Sets the sentDate value for this Task.
 void setServerAddress(java.lang.String serverAddress)
          Sets the serverAddress value for this Task.
 void setService(Service service)
          Sets the service value for this Task.
 void setSharepointDiscussionUrl(java.lang.String sharepointDiscussionUrl)
          Sets the sharepointDiscussionUrl value for this Task.
 void setStatus(java.lang.String status)
          Sets the status value for this Task.
 void setSubject(java.lang.String subject)
          Sets the subject value for this Task.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Task

public Task()

Task

public Task(java.lang.String activityName,
            java.lang.String assignedToRole,
            java.lang.String assignedToUser,
            InfoPathFormAttachment attachedInfoPathForm,
            BusinessData businessData,
            java.lang.String closedBy,
            java.util.Calendar closedDate,
            java.util.Calendar dueDate,
            long id,
            java.lang.String narrative,
            java.lang.String participant,
            java.lang.String participantDisplayName,
            java.lang.String priority,
            java.lang.Integer priorityRanking,
            ProcessInstance processInstance,
            java.util.Calendar readDate,
            java.util.Calendar receivedDate,
            java.util.Calendar sentDate,
            java.lang.String serverAddress,
            Service service,
            java.lang.String status,
            java.lang.String subject,
            ActionPermission[] actionPermissions,
            java.lang.String sharepointDiscussionUrl,
            ExternalActivityAttachment attachedExternalActivity)
Method Detail

getActivityName

public java.lang.String getActivityName()
Gets the activityName value for this Task.

Returns:
activityName * The name of the activity in the associated process (if applicable) Can be missing or nil if the Task is only partially loaded or if the task is not associated with a process instance.

setActivityName

public void setActivityName(java.lang.String activityName)
Sets the activityName value for this Task.

Parameters:
activityName - * The name of the activity in the associated process (if applicable) Can be missing or nil if the Task is only partially loaded or if the task is not associated with a process instance.

getAssignedToRole

public java.lang.String getAssignedToRole()
Gets the assignedToRole value for this Task.

Returns:
assignedToRole * The name of the role to which this task is assigned (if applicable). This value is mutually exclusive with AssignedToUser. Can be missing or nil if the Task is only partially loaded or if the task was never assigned to a role.

setAssignedToRole

public void setAssignedToRole(java.lang.String assignedToRole)
Sets the assignedToRole value for this Task.

Parameters:
assignedToRole - * The name of the role to which this task is assigned (if applicable). This value is mutually exclusive with AssignedToUser. Can be missing or nil if the Task is only partially loaded or if the task was never assigned to a role.

getAssignedToUser

public java.lang.String getAssignedToUser()
Gets the assignedToUser value for this Task.

Returns:
assignedToUser * The name of the user to which this task is assigned (if applicable). This value is mutually exclusive with AssignedToRole. Can be missing or nil if the Task is only partially loaded or if the task was never assigned to a user.

setAssignedToUser

public void setAssignedToUser(java.lang.String assignedToUser)
Sets the assignedToUser value for this Task.

Parameters:
assignedToUser - * The name of the user to which this task is assigned (if applicable). This value is mutually exclusive with AssignedToRole. Can be missing or nil if the Task is only partially loaded or if the task was never assigned to a user.

getAttachedInfoPathForm

public InfoPathFormAttachment getAttachedInfoPathForm()
Gets the attachedInfoPathForm value for this Task.

Returns:
attachedInfoPathForm * For use by WLE for Office

setAttachedInfoPathForm

public void setAttachedInfoPathForm(InfoPathFormAttachment attachedInfoPathForm)
Sets the attachedInfoPathForm value for this Task.

Parameters:
attachedInfoPathForm - * For use by WLE for Office

getBusinessData

public BusinessData getBusinessData()
Gets the businessData value for this Task.

Returns:
businessData * The BusinessData requested as part of a search or saved search when that search is organized by Task instead of by ProcessInstance. This does not include all the variables used by the associated process instance - only those specified as search columns and/or constraints. Can be missing or nil if the Task is only partially loaded or if the task is not associated with a process instance or if the task was loaded via some other means besides a saved search.

setBusinessData

public void setBusinessData(BusinessData businessData)
Sets the businessData value for this Task.

Parameters:
businessData - * The BusinessData requested as part of a search or saved search when that search is organized by Task instead of by ProcessInstance. This does not include all the variables used by the associated process instance - only those specified as search columns and/or constraints. Can be missing or nil if the Task is only partially loaded or if the task is not associated with a process instance or if the task was loaded via some other means besides a saved search.

getClosedBy

public java.lang.String getClosedBy()
Gets the closedBy value for this Task.

Returns:
closedBy * The name of the user that closed this task (if applicable) Can be missing or nil if the Task is only partially loaded or if the task is not yet closed.

setClosedBy

public void setClosedBy(java.lang.String closedBy)
Sets the closedBy value for this Task.

Parameters:
closedBy - * The name of the user that closed this task (if applicable) Can be missing or nil if the Task is only partially loaded or if the task is not yet closed.

getClosedDate

public java.util.Calendar getClosedDate()
Gets the closedDate value for this Task.

Returns:
closedDate * The date the task was closed (if applicable) Can be missing or nil if the Task is only partially loaded or if the task is not yet closed.

setClosedDate

public void setClosedDate(java.util.Calendar closedDate)
Sets the closedDate value for this Task.

Parameters:
closedDate - * The date the task was closed (if applicable) Can be missing or nil if the Task is only partially loaded or if the task is not yet closed.

getDueDate

public java.util.Calendar getDueDate()
Gets the dueDate value for this Task.

Returns:
dueDate * The due date of the task. Can be missing or nil if the Task is only partially loaded.

setDueDate

public void setDueDate(java.util.Calendar dueDate)
Sets the dueDate value for this Task.

Parameters:
dueDate - * The due date of the task. Can be missing or nil if the Task is only partially loaded.

getId

public long getId()
Gets the id value for this Task.

Returns:
id * The environment specific identifier of this task.

setId

public void setId(long id)
Sets the id value for this Task.

Parameters:
id - * The environment specific identifier of this task.

getNarrative

public java.lang.String getNarrative()
Gets the narrative value for this Task.

Returns:
narrative * The extended description of the task. Can be missing or nil if the Task is only partially loaded.

setNarrative

public void setNarrative(java.lang.String narrative)
Sets the narrative value for this Task.

Parameters:
narrative - * The extended description of the task. Can be missing or nil if the Task is only partially loaded.

getParticipant

public java.lang.String getParticipant()
Gets the participant value for this Task.

Returns:
participant * The current participant (either role or user) associated with this task. This is a special field that contains either the value of AssignedToUser or AssignedToRole depending on which value is set. Can be missing or nil if the Task is only partially loaded.

setParticipant

public void setParticipant(java.lang.String participant)
Sets the participant value for this Task.

Parameters:
participant - * The current participant (either role or user) associated with this task. This is a special field that contains either the value of AssignedToUser or AssignedToRole depending on which value is set. Can be missing or nil if the Task is only partially loaded.

getParticipantDisplayName

public java.lang.String getParticipantDisplayName()
Gets the participantDisplayName value for this Task.

Returns:
participantDisplayName * The current participant (either role or user) associated with this task. This is a special field that contains either the value of AssignedToUser or AssignedToRole depending on which value is set. This field is different in that it should be unambiguous which version it refers to. Can be missing or nil if the Task is only partially loaded.

setParticipantDisplayName

public void setParticipantDisplayName(java.lang.String participantDisplayName)
Sets the participantDisplayName value for this Task.

Parameters:
participantDisplayName - * The current participant (either role or user) associated with this task. This is a special field that contains either the value of AssignedToUser or AssignedToRole depending on which value is set. This field is different in that it should be unambiguous which version it refers to. Can be missing or nil if the Task is only partially loaded.

getPriority

public java.lang.String getPriority()
Gets the priority value for this Task.

Returns:
priority * The priority of this task. Can be missing or nil if the Task is only partially loaded.

setPriority

public void setPriority(java.lang.String priority)
Sets the priority value for this Task.

Parameters:
priority - * The priority of this task. Can be missing or nil if the Task is only partially loaded.

getPriorityRanking

public java.lang.Integer getPriorityRanking()
Gets the priorityRanking value for this Task.

Returns:
priorityRanking * The ranking of priority of this task used for sorting tasks by priority (since the value of the Priority element is a string name and may not sort in the order intended by the author). Can be missing or nil if the Task is only partially loaded.

setPriorityRanking

public void setPriorityRanking(java.lang.Integer priorityRanking)
Sets the priorityRanking value for this Task.

Parameters:
priorityRanking - * The ranking of priority of this task used for sorting tasks by priority (since the value of the Priority element is a string name and may not sort in the order intended by the author). Can be missing or nil if the Task is only partially loaded.

getProcessInstance

public ProcessInstance getProcessInstance()
Gets the processInstance value for this Task.

Returns:
processInstance * The associated process instance (if applicable). In situations where the task is the main object returned, the value of ProcessInstance may be duplicated for each related task. Check the documentation of the operation to see what elements in the ProcessInstance are populated for this task object. Can be missing or nil if the Task is only partially loaded or if the task is not associated with a process instance.

setProcessInstance

public void setProcessInstance(ProcessInstance processInstance)
Sets the processInstance value for this Task.

Parameters:
processInstance - * The associated process instance (if applicable). In situations where the task is the main object returned, the value of ProcessInstance may be duplicated for each related task. Check the documentation of the operation to see what elements in the ProcessInstance are populated for this task object. Can be missing or nil if the Task is only partially loaded or if the task is not associated with a process instance.

getReadDate

public java.util.Calendar getReadDate()
Gets the readDate value for this Task.

Returns:
readDate * The date that the task was read by the assigned user. Can be missing or nil if the Task is only partially loaded or if the task has not been marked as read by the client.

setReadDate

public void setReadDate(java.util.Calendar readDate)
Sets the readDate value for this Task.

Parameters:
readDate - * The date that the task was read by the assigned user. Can be missing or nil if the Task is only partially loaded or if the task has not been marked as read by the client.

getReceivedDate

public java.util.Calendar getReceivedDate()
Gets the receivedDate value for this Task.

Returns:
receivedDate * The date the task was received by its assigned participant. Can be missing or nil if the Task is only partially loaded or if the task has not been received.

setReceivedDate

public void setReceivedDate(java.util.Calendar receivedDate)
Sets the receivedDate value for this Task.

Parameters:
receivedDate - * The date the task was received by its assigned participant. Can be missing or nil if the Task is only partially loaded or if the task has not been received.

getSentDate

public java.util.Calendar getSentDate()
Gets the sentDate value for this Task.

Returns:
sentDate * The date the task was sent to its assigned participant. Can be missing or nil if the Task is only partially loaded.

setSentDate

public void setSentDate(java.util.Calendar sentDate)
Sets the sentDate value for this Task.

Parameters:
sentDate - * The date the task was sent to its assigned participant. Can be missing or nil if the Task is only partially loaded.

getServerAddress

public java.lang.String getServerAddress()
Gets the serverAddress value for this Task.

Returns:
serverAddress * deprecated As of version 6.0.1

setServerAddress

public void setServerAddress(java.lang.String serverAddress)
Sets the serverAddress value for this Task.

Parameters:
serverAddress - * deprecated As of version 6.0.1

getService

public Service getService()
Gets the service value for this Task.

Returns:
service * The associated service for this task (if applicable) Can be missing or nil if the Task is only partially loaded or if the task is not associated with a service.

setService

public void setService(Service service)
Sets the service value for this Task.

Parameters:
service - * The associated service for this task (if applicable) Can be missing or nil if the Task is only partially loaded or if the task is not associated with a service.

getStatus

public java.lang.String getStatus()
Gets the status value for this Task.

Returns:
status * The status of this task. Can be missing or nil if the Task is only partially loaded.

setStatus

public void setStatus(java.lang.String status)
Sets the status value for this Task.

Parameters:
status - * The status of this task. Can be missing or nil if the Task is only partially loaded.

getSubject

public java.lang.String getSubject()
Gets the subject value for this Task.

Returns:
subject * The short description of the task that typically appears as a column in a list of tasks. Can be missing or nil if the Task is only partially loaded.

setSubject

public void setSubject(java.lang.String subject)
Sets the subject value for this Task.

Parameters:
subject - * The short description of the task that typically appears as a column in a list of tasks. Can be missing or nil if the Task is only partially loaded.

getActionPermissions

public ActionPermission[] getActionPermissions()
Gets the actionPermissions value for this Task.

Returns:
actionPermissions * The action permissions associated with this task. Populated if the task was returned from a search or saved search. Can be missing or nil if the Task is only partially loaded.

setActionPermissions

public void setActionPermissions(ActionPermission[] actionPermissions)
Sets the actionPermissions value for this Task.

Parameters:
actionPermissions - * The action permissions associated with this task. Populated if the task was returned from a search or saved search. Can be missing or nil if the Task is only partially loaded.

getSharepointDiscussionUrl

public java.lang.String getSharepointDiscussionUrl()
Gets the sharepointDiscussionUrl value for this Task.

Returns:
sharepointDiscussionUrl * For use by WLE for Sharepoint

setSharepointDiscussionUrl

public void setSharepointDiscussionUrl(java.lang.String sharepointDiscussionUrl)
Sets the sharepointDiscussionUrl value for this Task.

Parameters:
sharepointDiscussionUrl - * For use by WLE for Sharepoint

getAttachedExternalActivity

public ExternalActivityAttachment getAttachedExternalActivity()
Gets the attachedExternalActivity value for this Task.

Returns:
attachedExternalActivity * The attached external activity if the task is for an activity that is using an External Activity implementation. The attachment contains the external activity definition and the associated data. Can be missing or nil if the Task is only partially loaded or if the task is not associated with an activity using an external activity implementation.

setAttachedExternalActivity

public void setAttachedExternalActivity(ExternalActivityAttachment attachedExternalActivity)
Sets the attachedExternalActivity value for this Task.

Parameters:
attachedExternalActivity - * The attached external activity if the task is for an activity that is using an External Activity implementation. The attachment contains the external activity definition and the associated data. Can be missing or nil if the Task is only partially loaded or if the task is not associated with an activity using an external activity implementation.

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()
Return type metadata object


getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)
Get Custom Serializer


getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)
Get Custom Deserializer


IBM BPM API for Web Service Clients v8.0.0

(C) Copyright IBM Corporation 2011. All Rights Reserved.