|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CreateTaskInfo
This interface is used to create a new task. To create a task in the system,
populate all of the relevant values for a particular task and
call TaskManager.createTask()
.
Nested Class Summary | |
---|---|
static interface |
CreateTaskInfo.PriorityValues
The possible priority values for the task. |
Method Summary | |
---|---|
void |
addACLsForSharedQueues(boolean createACLs)
Sets whether access control lists should be set for users who have access to the queue to which the new task is assigned. |
void |
copyAttachments(boolean copyAttachments)
Deprecated. This is still supported for backwards compatibility. However, the method of storing a list of documents for task attachments is preferred. |
void |
isStartTask(boolean startTask)
Determines whether this is a start task. |
void |
setActionId(long actionId)
Sets the action identifier that corresponds to this task, if this task is part of an orchestration. |
void |
setAssignTo(ParticipantInfo assignTo)
Defines to whom the task will be assigned. |
void |
setAttachmentDocumentList(java.util.List attachmentDocs)
Copies the attachments from a list of documents to the task attachments. |
void |
setClassOfTask(java.lang.String classOfTask)
Sets the Class for the task. |
void |
setConsultGroup(java.lang.String groupDomainId,
java.lang.String groupCanonicalName)
Sets the consult group based on the domain identifier and group canonical name. |
void |
setConsultGroupId(java.lang.String consultGroupId)
Sets an identifier for the group with which users can consult on this task. |
void |
setDeadline(java.util.Date deadline)
Deprecated. use the getDeadlineInfo/setDeadlineInfo instead |
void |
setDeadlineInfo(TaskTimerInfo deadlineInfo)
Sets the deadlineInfo for this task. |
void |
setDeadlineInstructions(java.lang.String deadlineInstructions)
Sets deadline instructions to be used if a deadline fires. |
void |
setDeadlineRouteName(java.lang.String deadlineRouteName)
Sets which route to follow for a long-lived task when a deadline fires. |
void |
setDefaultACLs(TaskACL defaultACL)
Sets the default access control list (ACL) for this task. |
void |
setDescription(java.lang.String descriptionText)
Sets a description of this task for the user. |
void |
setEscalateTo(ParticipantInfo escalateTo)
Defines to whom the task will be escalated when TaskManager.escalateTask() is called. |
void |
setEscalation(java.util.Date escalation)
Deprecated. use the getEscalationInfo/setEscalationInfo instead |
void |
setEscalationInfo(TaskTimerInfo escalationInfo)
Sets the escalationInfo for this task. |
void |
setFirstReminder(java.util.Date reminder)
Deprecated. use the getFirstReminderInfo/setFirstReminderInfo instead |
void |
setFirstReminderInfo(TaskTimerInfo firstReminderInfo)
Sets the firstReminderInfo for this task. |
void |
setForwardGroup(java.lang.String groupDomainId,
java.lang.String groupCanonicalName)
Sets the forward group based on the domain identifier and group canonical name. |
void |
setForwardGroupId(java.lang.String forwardGroupId)
Sets an identifier for the group to which users can forward this task. |
void |
setInstructions(java.lang.String instructionsText)
Sets the instructions metadata (text) associated with the task. |
void |
setLongLivedInvocationId(java.lang.String aInvocationId)
Provides the task with a way to store the long-lived invocation that created the task. |
void |
setOutOfOfficeEligible(boolean eligible)
Declares whether the task to be created can have an OutOfOffice designation. |
void |
setOutOfOfficeEligibleEscalations(boolean eligible)
Declares whether the task to be created can have an OutOfOffice designation for escalations. |
void |
setPriority(short priority)
Sets a priority for this task. |
void |
setProcessInstanceId(long processId)
Sets the process identifier for this task. |
void |
setProcessMajorVersion(int majorVersion)
Sets the major version of the process |
void |
setProcessMinorVersion(int minorVersion)
Sets the minor version of the process |
void |
setProcessName(java.lang.String aProcessName)
Provides the opportunity for an orchestrated service calling TaskManager.createTask() to provide the process name. |
void |
setProcessTitle(java.lang.String aProcessTitle)
Sets the process title for this process |
void |
setReminderInstructions(java.lang.String aReminderInstructions)
Sets instructions for the task once a reminder is issued. |
void |
setReminderRepeatMinutes(long reminderRepeatMinutes)
Deprecated. use the getRepeatReminderInfo/setRepeatReminderInfo instead |
void |
setRepeatReminderInfo(TaskTimerInfo repeatReminderInfo)
Sets the RepeatReminderInfo for this task. |
void |
setRouteList(java.lang.String[] routes)
Sets a route list for the user to choose from. |
void |
setRouteSelectionRequired(boolean routeRequired)
Sets whether it is required that a user choose a route before completing the task. |
void |
setSelectedRoute(java.lang.String selectedRoute)
Sets the default selected route. |
void |
setStepName(java.lang.String stepName)
Sets the step name for this task. |
void |
setTaskACLs(TaskACL[] acls)
Sets an access control list for this task. |
void |
setTaskItems(FormInstance[] forms)
Sets the task items (sometimes called Forms) for the task. |
void |
setTaskUIOptions(TaskUIOptions taskUIOptions)
Sets Task UI Options for this task. |
void |
showAttachments(boolean showAttachments)
A hint for the user interface that indicates whether to show the attachment window for this task. |
Method Detail |
---|
void setTaskItems(FormInstance[] forms)
forms
- An array of FormInstance
objects representing the task items.void setDeadline(java.util.Date deadline)
deadline
- A Date
object indicating a deadline for the task.void setDeadlineInstructions(java.lang.String deadlineInstructions)
deadlineInstructions
- A String
with new instructions for the task.void setDeadlineRouteName(java.lang.String deadlineRouteName)
deadlineRouteName
- A String
representing the valid outbound
route to follow from this step in the process.void setEscalation(java.util.Date escalation)
escalation
- A Date
object indicating when to the escalate the task.void setLongLivedInvocationId(java.lang.String aInvocationId)
aInvocationId
- A job identifier for the invocation request.void setFirstReminder(java.util.Date reminder)
reminder
- A Date
object indicating when to issue the reminder for the task.void setReminderInstructions(java.lang.String aReminderInstructions)
aReminderInstructions
- The new instructions for the task upon issuing the reminder.void setReminderRepeatMinutes(long reminderRepeatMinutes)
reminderRepeatMinutes
- The number of minutes after the initial reminder for another reminder to be sent.void showAttachments(boolean showAttachments)
showAttachments
- true
if the attachment window for this task should be shown, false
otherwise.void copyAttachments(boolean copyAttachments)
copyAttachments
- The attachments from the previous task.void setAttachmentDocumentList(java.util.List attachmentDocs)
attachmentDocs
- The list of documents containing the attachments.void setAssignTo(ParticipantInfo assignTo)
assignTo
- A ParticipantInfo
object indicating to whom the task will be assigned.void setEscalateTo(ParticipantInfo escalateTo)
TaskManager.escalateTask()
is called.
escalateTo
- A ParticipantInfo
object indicating to whom the task will be escalated.void setActionId(long actionId)
actionId
- The action identifier that corresponds to this task.void setProcessInstanceId(long processId)
processId
- The process identifier for this task.void setProcessName(java.lang.String aProcessName)
TaskManager.createTask()
to provide the process name.
aProcessName
- The name of the process with which this task is associated.void setProcessTitle(java.lang.String aProcessTitle)
aProcessTitle
- the process titlevoid setProcessMajorVersion(int majorVersion)
minorVersion
- void setProcessMinorVersion(int minorVersion)
minorVersion
- void setInstructions(java.lang.String instructionsText)
instructionsText
- Instructions for the user.void setDescription(java.lang.String descriptionText)
descriptionText
- The description of this task.void setStepName(java.lang.String stepName)
stepName
- void setTaskACLs(TaskACL[] acls)
acls
- The access control list for this task.TaskACL
void addACLsForSharedQueues(boolean createACLs)
true
(for backwards compatibility).
createACLs
- true
if access control lists should be set for users
who have access to the queue to which the new task is assigned, false
otherwise.void isStartTask(boolean startTask)
startTask
- true
if this is a start task, false
otherwise.void setDefaultACLs(TaskACL defaultACL)
defaultACL
- The default access control list (ACL) for this task.void setRouteList(java.lang.String[] routes)
routes
- A route list for the user to choose from.void setSelectedRoute(java.lang.String selectedRoute)
selectedRoute
- The default selected route.void setRouteSelectionRequired(boolean routeRequired)
routeRequired
- true
if a user must choose a route before completing the task, false
otherwise.void setForwardGroupId(java.lang.String forwardGroupId)
forwardGroupId
- The identifier of the group to which to allow forwarding.void setForwardGroup(java.lang.String groupDomainId, java.lang.String groupCanonicalName)
groupDomainId
- The domain identifier for the group.groupCanonicalName
- The group's canonical name.void setConsultGroupId(java.lang.String consultGroupId)
consultGroupId
- The identifier of the group with which users can consult on this task.void setConsultGroup(java.lang.String groupDomainId, java.lang.String groupCanonicalName)
groupDomainId
- The domain identifier for the group.groupCanonicalName
- The group's canonical name.void setPriority(short priority)
priority
- The priority for this task.com.adobe.idp.taskmanager.dsc.client.task.CreateTaskInfo#PriorityValues
void setOutOfOfficeEligible(boolean eligible)
eligible
- true if this task should have Out Of Office designations appliedvoid setOutOfOfficeEligibleEscalations(boolean eligible)
eligible
- true if this task should have Out Of Office designations appliedvoid setDeadlineInfo(TaskTimerInfo deadlineInfo)
deadlineInfo
- The deadlineInfo for this task.void setEscalationInfo(TaskTimerInfo escalationInfo)
escalationInfo
- The escalationInfo for this task.void setFirstReminderInfo(TaskTimerInfo firstReminderInfo)
firstReminderInfo
- The firstReminderInfo for this task.void setRepeatReminderInfo(TaskTimerInfo repeatReminderInfo)
repeatReminderInfo
- The RepeatReminderInfo for this task.void setClassOfTask(java.lang.String classOfTask)
TaskManagerConstants.TaskClassTypes.Standard
classOfTask
- the class of task. You can use the built-in class types or a custom class typevoid setTaskUIOptions(TaskUIOptions taskUIOptions)
taskUIOptions
- the settings for this task.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |