com.adobe.idp.taskmanager.dsc.client.task
Interface CreateTaskInfo

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

TaskInfo

public interface CreateTaskInfo
extends java.io.Serializable

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().

Since:

8.0

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

setTaskItems

void setTaskItems(FormInstance[] forms)

Sets the task items (sometimes called Forms) for the task.

Parameters:

forms - An array of FormInstance objects representing the task items.

setDeadline

void setDeadline(java.util.Date deadline)

Deprecated. use the getDeadlineInfo/setDeadlineInfo instead

Sets a deadline for the task.

Parameters:

deadline - A Date object indicating a deadline for the task.

setDeadlineInstructions

void setDeadlineInstructions(java.lang.String deadlineInstructions)

Sets deadline instructions to be used if a deadline fires.

Parameters:

deadlineInstructions - A String with new instructions for the task.

setDeadlineRouteName

void setDeadlineRouteName(java.lang.String deadlineRouteName)

Sets which route to follow for a long-lived task when a deadline fires.

Parameters:

deadlineRouteName - A String representing the valid outbound route to follow from this step in the process.

setEscalation

void setEscalation(java.util.Date escalation)

Deprecated. use the getEscalationInfo/setEscalationInfo instead

Sets an escalation for the task. You must also specify to whom the task should be escalated.

Parameters:

escalation - A Date object indicating when to the escalate the task.

setLongLivedInvocationId

void setLongLivedInvocationId(java.lang.String aInvocationId)

Provides the task with a way to store the long-lived invocation that created the task. The invocation should be notified when the task is complete.

Parameters:

aInvocationId - A job identifier for the invocation request.

setFirstReminder

void setFirstReminder(java.util.Date reminder)

Deprecated. use the getFirstReminderInfo/setFirstReminderInfo instead

Sets a reminder for the task.

Parameters:

reminder - A Date object indicating when to issue the reminder for the task.

setReminderInstructions

void setReminderInstructions(java.lang.String aReminderInstructions)

Sets instructions for the task once a reminder is issued.

Parameters:

aReminderInstructions - The new instructions for the task upon issuing the reminder.

setReminderRepeatMinutes

void setReminderRepeatMinutes(long reminderRepeatMinutes)

Deprecated. use the getRepeatReminderInfo/setRepeatReminderInfo instead

Sets a time, in minutes, for reminders to be issued after the initial reminder. These reminders will be issued until the task is completed.

Parameters:

reminderRepeatMinutes - The number of minutes after the initial reminder for another reminder to be sent.

showAttachments

void showAttachments(boolean showAttachments)

A hint for the user interface that indicates whether to show the attachment window for this task.

Parameters:

showAttachments - true if the attachment window for this task should be shown, false otherwise.

copyAttachments

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.

Copies attachments from the previous task.

Parameters:

copyAttachments - The attachments from the previous task.

setAttachmentDocumentList

void setAttachmentDocumentList(java.util.List attachmentDocs)

Copies the attachments from a list of documents to the task attachments.

Parameters:

attachmentDocs - The list of documents containing the attachments.

setAssignTo

void setAssignTo(ParticipantInfo assignTo)

Defines to whom the task will be assigned.

Parameters:

assignTo - A ParticipantInfo object indicating to whom the task will be assigned.

setEscalateTo

void setEscalateTo(ParticipantInfo escalateTo)

Defines to whom the task will be escalated when TaskManager.escalateTask() is called.

Parameters:

escalateTo - A ParticipantInfo object indicating to whom the task will be escalated.

setActionId

void setActionId(long actionId)

Sets the action identifier that corresponds to this task, if this task is part of an orchestration.

Parameters:

actionId - The action identifier that corresponds to this task.

setProcessInstanceId

void setProcessInstanceId(long processId)

Sets the process identifier for this task.

Parameters:

processId - The process identifier for this task.

setProcessName

void setProcessName(java.lang.String aProcessName)

Provides the opportunity for an orchestrated service calling TaskManager.createTask() to provide the process name.

Parameters:

aProcessName - The name of the process with which this task is associated.

setProcessTitle

void setProcessTitle(java.lang.String aProcessTitle)

Sets the process title for this process

Parameters:

aProcessTitle - the process title

setProcessMajorVersion

void setProcessMajorVersion(int majorVersion)

Sets the major version of the process

Parameters:

minorVersion -

setProcessMinorVersion

void setProcessMinorVersion(int minorVersion)

Sets the minor version of the process

Parameters:

minorVersion -

setInstructions

void setInstructions(java.lang.String instructionsText)

Sets the instructions metadata (text) associated with the task. These instructions are normally for the user to whom this task is assigned. They appear in end user applications or email notifications.

Parameters:

instructionsText - Instructions for the user.

setDescription

void setDescription(java.lang.String descriptionText)

Sets a description of this task for the user.

Parameters:

descriptionText - The description of this task.

setStepName

void setStepName(java.lang.String stepName)

Sets the step name for this task. This item usually contains the action name from an orchestration.

Parameters:

stepName -

setTaskACLs

void setTaskACLs(TaskACL[] acls)

Sets an access control list for this task.

Parameters:

acls - The access control list for this task.

See Also:

TaskACL

addACLsForSharedQueues

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. The default is true (for backwards compatibility).

Parameters:

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.

isStartTask

void isStartTask(boolean startTask)

Determines whether this is a start task.

Parameters:

startTask - true if this is a start task, false otherwise.

setDefaultACLs

void setDefaultACLs(TaskACL defaultACL)

Sets the default access control list (ACL) for this task. When a user is given access to the task or has the task forwarded to him, this default ACL will be used to populate the newly assigned user's ACL.

Parameters:

defaultACL - The default access control list (ACL) for this task.

setRouteList

void setRouteList(java.lang.String[] routes)

Sets a route list for the user to choose from. The list will be used to follow a particular route in an orchestration.

Parameters:

routes - A route list for the user to choose from.

setSelectedRoute

void setSelectedRoute(java.lang.String selectedRoute)

Sets the default selected route.

Parameters:

selectedRoute - The default selected route.

setRouteSelectionRequired

void setRouteSelectionRequired(boolean routeRequired)

Sets whether it is required that a user choose a route before completing the task.

Parameters:

routeRequired - true if a user must choose a route before completing the task, false otherwise.

setForwardGroupId

void setForwardGroupId(java.lang.String forwardGroupId)

Sets an identifier for the group to which users can forward this task. If this value is set, this task can only be forwarded to members of the indicated group.

Parameters:

forwardGroupId - The identifier of the group to which to allow forwarding.

setForwardGroup

void setForwardGroup(java.lang.String groupDomainId,
                     java.lang.String groupCanonicalName)

Sets the forward group based on the domain identifier and group canonical name. This method is provided because these values identify a group that is universal across deployments using the same user domain setup.

Parameters:

groupDomainId - The domain identifier for the group.

groupCanonicalName - The group's canonical name.

setConsultGroupId

void setConsultGroupId(java.lang.String consultGroupId)

Sets an identifier for the group with which users can consult on this task. If this value is set, this task can only be consulted with members of the indicated group.

Parameters:

consultGroupId - The identifier of the group with which users can consult on this task.

setConsultGroup

void setConsultGroup(java.lang.String groupDomainId,
                     java.lang.String groupCanonicalName)

Sets the consult group based on the domain identifier and group canonical name. This method is provided because these values identify a group that is universal across deployments using the same user domain setup.

Parameters:

groupDomainId - The domain identifier for the group.

groupCanonicalName - The group's canonical name.

setPriority

void setPriority(short priority)

Sets a priority for this task.

Parameters:

priority - The priority for this task.

See Also:

com.adobe.idp.taskmanager.dsc.client.task.CreateTaskInfo#PriorityValues

setOutOfOfficeEligible

void setOutOfOfficeEligible(boolean eligible)

Declares whether the task to be created can have an OutOfOffice designation. Tasks of a private nature should not be Out Of Office eligible. The default value is True, meaning to do Out Of Office designations for this task

Parameters:

eligible - true if this task should have Out Of Office designations applied

Since:

first implemented in LC8.2

setOutOfOfficeEligibleEscalations

void setOutOfOfficeEligibleEscalations(boolean eligible)

Declares whether the task to be created can have an OutOfOffice designation for escalations. Tasks of a private nature should not be Out Of Office eligible. The default value is True, meaning to do Out Of Office designations for escalations

Parameters:

eligible - true if this task should have Out Of Office designations applied

Since:

first implemented in LC8.2

setDeadlineInfo

void setDeadlineInfo(TaskTimerInfo deadlineInfo)

Sets the deadlineInfo for this task.

Parameters:

deadlineInfo - The deadlineInfo for this task.

setEscalationInfo

void setEscalationInfo(TaskTimerInfo escalationInfo)

Sets the escalationInfo for this task.

Parameters:

escalationInfo - The escalationInfo for this task.

setFirstReminderInfo

void setFirstReminderInfo(TaskTimerInfo firstReminderInfo)

Sets the firstReminderInfo for this task.

Parameters:

firstReminderInfo - The firstReminderInfo for this task.

setRepeatReminderInfo

void setRepeatReminderInfo(TaskTimerInfo repeatReminderInfo)

Sets the RepeatReminderInfo for this task.

Parameters:

repeatReminderInfo - The RepeatReminderInfo for this task.

setClassOfTask

void setClassOfTask(java.lang.String classOfTask)

Sets the Class for the task. The default class is TaskManagerConstants.TaskClassTypes.Standard

Parameters:

classOfTask - the class of task. You can use the built-in class types or a custom class type

setTaskUIOptions

void setTaskUIOptions(TaskUIOptions taskUIOptions)

Sets Task UI Options for this task.

Parameters:

taskUIOptions - the settings for this task.