|
IBM BPM API for Web Service Clients v8.0.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lombardisoftware.webapi.Task
public class Task
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).
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 |
---|
public 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 |
---|
public java.lang.String getActivityName()
public void setActivityName(java.lang.String activityName)
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.public java.lang.String getAssignedToRole()
public void setAssignedToRole(java.lang.String assignedToRole)
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.public java.lang.String getAssignedToUser()
public void setAssignedToUser(java.lang.String assignedToUser)
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.public InfoPathFormAttachment getAttachedInfoPathForm()
public void setAttachedInfoPathForm(InfoPathFormAttachment attachedInfoPathForm)
attachedInfoPathForm
- * For use by WLE for Officepublic BusinessData getBusinessData()
public void setBusinessData(BusinessData businessData)
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.public java.lang.String getClosedBy()
public void setClosedBy(java.lang.String closedBy)
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.public java.util.Calendar getClosedDate()
public void setClosedDate(java.util.Calendar closedDate)
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.public java.util.Calendar getDueDate()
public void setDueDate(java.util.Calendar dueDate)
dueDate
- * The due date of the task.
Can be missing or nil if the Task is only partially
loaded.public long getId()
public void setId(long id)
id
- * The environment specific identifier of this task.public java.lang.String getNarrative()
public void setNarrative(java.lang.String narrative)
narrative
- * The extended description of the task.
Can be missing or nil if the Task is only partially
loaded.public java.lang.String getParticipant()
public void setParticipant(java.lang.String participant)
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.public java.lang.String getParticipantDisplayName()
public void setParticipantDisplayName(java.lang.String participantDisplayName)
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.public java.lang.String getPriority()
public void setPriority(java.lang.String priority)
priority
- * The priority of this task.
Can be missing or nil if the Task is only partially
loaded.public java.lang.Integer getPriorityRanking()
public void setPriorityRanking(java.lang.Integer priorityRanking)
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.public ProcessInstance getProcessInstance()
public void setProcessInstance(ProcessInstance processInstance)
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.public java.util.Calendar getReadDate()
public void setReadDate(java.util.Calendar readDate)
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.public java.util.Calendar getReceivedDate()
public void setReceivedDate(java.util.Calendar receivedDate)
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.public java.util.Calendar getSentDate()
public void setSentDate(java.util.Calendar sentDate)
sentDate
- * The date the task was sent to its assigned participant.
Can be missing or nil if the Task is only partially
loaded.public java.lang.String getServerAddress()
public void setServerAddress(java.lang.String serverAddress)
serverAddress
- * deprecated As of version 6.0.1public Service getService()
public void setService(Service service)
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.public java.lang.String getStatus()
public void setStatus(java.lang.String status)
status
- * The status of this task.
Can be missing or nil if the Task is only partially
loaded.public java.lang.String getSubject()
public void setSubject(java.lang.String subject)
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.public ActionPermission[] getActionPermissions()
public void setActionPermissions(ActionPermission[] actionPermissions)
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.public java.lang.String getSharepointDiscussionUrl()
public void setSharepointDiscussionUrl(java.lang.String sharepointDiscussionUrl)
sharepointDiscussionUrl
- * For use by WLE for Sharepointpublic ExternalActivityAttachment getAttachedExternalActivity()
public void setAttachedExternalActivity(ExternalActivityAttachment attachedExternalActivity)
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.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public static org.apache.axis.description.TypeDesc getTypeDesc()
public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
|
IBM BPM API for Web Service Clients v8.0.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |