com.attask.beans.api
Interface AddTemplateTaskMessage

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

EditTemplateTaskMessage

All Known Implementing Classes:

TemplateTaskBean

public interface AddTemplateTaskMessage
extends java.io.Serializable

Field Summary

static java.lang.String

SVNVersion

Method Summary

ApprovalBean	getApproval()
java.lang.String	getApprovalRequired()
ApproverBean[]	getApprovers()
int	getAssignedToID()
TemplateAssignmentBean[]	getAssignments()
java.lang.String[]	getAuditTypes()
double	getBillingAmount()
int	getCategoryID()
double	getCompletionDay()
double	getConstraintDay()
double	getCostAmount()
java.lang.String	getCostType()
java.lang.String	getDescription()
double	getDuration()
java.lang.String	getDurationType()
java.lang.String	getDurationUnit()
java.lang.String	getExtRefID()
boolean	getForceEdit() Force Edit.
int	getID()
boolean	getIsLevelingExcluded()
boolean	getIsRequired()
double	getLevelingStartDelay() Leveling Delays.
java.lang.String	getLevelingStartDelayUnit()
int	getMasterTaskID()
int	getMilestoneID()
java.lang.String	getName()
int	getParentID()
double	getParentLag()
java.lang.String	getParentLagType()
PredecessorBean[]	getPredecessors()
int	getPriority()
RecurrenceRuleBean	getRecurrenceRule()
int	getRecurrenceRuleID() Recurrence Rule
java.lang.String	getRevenueType()
int	getRoleID()
double	getStartDay()
java.lang.String	getTaskConstraint()
int	getTaskNumber()
int	getTemplateID()
java.lang.String	getTrackingMode()
java.lang.String	getURL()
double	getWork()
java.lang.String	getWorkUnit()
void	setApproval(ApprovalBean val) Approval Record.
void	setApprovalRequired(java.lang.String val) Approval Required.
void	setApprovers(ApproverBean[] val) Approvers.
void	setAssignedToID(int val) UserBean ID.
void	setAssignments(TemplateAssignmentBean[] val) Controls ability to set assignments.
void	setAuditTypes(java.lang.String[] vals) Audit Types.
void	setBillingAmount(double val) Billing Amount.
void	setCategoryID(int val) CategoryBean ID.
void	setCompletionDay(double val) CompletionDay can only be used if the TaskConstraint AddTaskMessage.setTaskConstraint(String) is set to "FIXT".
void	setConstraintDay(double val) Constraint Day.
void	setCostAmount(double val) Cost Amount.
void	setCostType(java.lang.String val) The Cost Type of this task.
void	setDescription(java.lang.String val) TemplateTask Description.
void	setDuration(double val) Duration Amount to complete the task.
void	setDurationType(java.lang.String val) See DurationTypeEnum.
void	setDurationUnit(java.lang.String val) See DurationUnitEnum.
void	setExtRefID(java.lang.String val) Task External Reference ID.
void	setForceEdit(boolean val)
void	setID(int val) TemplateTask ID.
void	setIsLevelingExcluded(boolean val)
void	setIsRequired(boolean val) Specifies whether a TemplateTask is added unconditionally to a Project created from this Template.
void	setLevelingStartDelay(double val)
void	setLevelingStartDelayUnit(java.lang.String val)
void	setMasterTaskID(int val) Master Task ID.
void	setMilestoneID(int val) MilestoneBean ID.
void	setName(java.lang.String val) TemplateTask Name.
void	setParentID(int val) TemplateTaskBean ID of this task's parent.
void	setParentLag(double val) Set Number of Lag Days to offset a child Task From a Parent Task or the Project.
void	setParentLagType(java.lang.String val) Sets the Parent Lag Type.
void	setPredecessors(PredecessorBean[] val) PredecessorBean[] that define a Tasks predecessors.
void	setPriority(int val) This value is between 4 (urgent) and 0 (low).
void	setRecurrenceRule(RecurrenceRuleBean val)
void	setRecurrenceRuleID(int val)
void	setRevenueType(java.lang.String val) The Revenue Type of this task.
void	setRoleID(int val) RoleBean ID.
void	setStartDay(double val) StartDay can only be used if the TaskConstraint AddTaskMessage.setTaskConstraint(String) is set to "FIXT".
void	setTaskConstraint(java.lang.String val) See TaskConstraintEnum.
void	setTaskNumber(int val) Task Number.
void	setTemplateID(int val) TemplateBean ID.
void	setTrackingMode(java.lang.String val) Must be one of the following: USER, ONTM, IGNR, AUTO corresponding to values of "User Must Update", "Assume On Time", "Ignore Late Warnings", and "Auto Complete".
void	setURL(java.lang.String val) Template Task's URL.
void	setWork(double val) Work Required to complete the task.
void	setWorkUnit(java.lang.String val) See DurationUnitEnum.

Field Detail

SVNVersion

static final java.lang.String SVNVersion

See Also:

Constant Field Values

Method Detail

setID

void setID(int val)

TemplateTask ID. This value MUST BE less than 0. It is a temporary ID to allow adding TemplateTasks with Parent and Predecessors relationships in a single batch call. ParentID and PredecessorBean.PredecessorID should use this value when referencing a TemplateTasks in the same call to API.addTemplateTasks(String, TemplateTaskBean[]) OPTIONAL.

getID

int getID()

setTaskNumber

void setTaskNumber(int val)

Task Number. Task Number is a unique identifier within the scope of a Template. This numbering begins at 1. If a value is not provided, one will be generated. Because invalid values for Task Number can result in InvalidTimelineStructureExceptions, it is best to leave this value blank unless you are familiar with these rules. OPTIONAL.

getTaskNumber

int getTaskNumber()

setName

@Required
void setName(java.lang.String val)

TemplateTask Name. REQUIRED.

getName

java.lang.String getName()

setDescription

void setDescription(java.lang.String val)

TemplateTask Description. OPTIONAL.

getDescription

java.lang.String getDescription()

setExtRefID

void setExtRefID(java.lang.String val)

Task External Reference ID. OPTIONAL.

getExtRefID

java.lang.String getExtRefID()

setURL

void setURL(java.lang.String val)

Template Task's URL. OPTIONAL.

getURL

java.lang.String getURL()

setDuration

void setDuration(double val)

Duration Amount to complete the task. This value is used in conjuntion with setDurationUnit(String val) to calculate an actual Duration. OPTIONAL.

getDuration

double getDuration()

setDurationUnit

void setDurationUnit(java.lang.String val)

See DurationUnitEnum. OPTIONAL.

getDurationUnit

java.lang.String getDurationUnit()

setWork

void setWork(double val)

Work Required to complete the task. This value is used in conjuntion with setWorkUnit(String val) to calculate an actual Work. OPTIONAL.

getWork

double getWork()

setWorkUnit

void setWorkUnit(java.lang.String val)

See DurationUnitEnum. OPTIONAL.

getWorkUnit

java.lang.String getWorkUnit()

setDurationType

void setDurationType(java.lang.String val)

See DurationTypeEnum. OPTIONAL.

getDurationType

java.lang.String getDurationType()

setPriority

void setPriority(int val)

This value is between 4 (urgent) and 0 (low). See TimelinePriorityEnum for details. If not provided or invalid, 2 (normal) will be used. OPTIONAL.

getPriority

int getPriority()

setTrackingMode

void setTrackingMode(java.lang.String val)

Must be one of the following: USER, ONTM, IGNR, AUTO corresponding to values of "User Must Update", "Assume On Time", "Ignore Late Warnings", and "Auto Complete". See TaskTrackingModeEnum for details. If not provided, "USER" is the default mode. OPTIONAL.

getTrackingMode

java.lang.String getTrackingMode()

setTaskConstraint

void setTaskConstraint(java.lang.String val)

See TaskConstraintEnum. OPTIONAL

getTaskConstraint

java.lang.String getTaskConstraint()

setConstraintDay

void setConstraintDay(double val)

Constraint Day. See TaskConstraintEnum. Because Templates deal with "days" rather than "dates", this field is used in the place of an actual date. This field represents a day offset from the Start Day or the Completion Day dependning on the ScheduleMode of the Template. OPTIONAL.

getConstraintDay

double getConstraintDay()

setParentLag

void setParentLag(double val)

Set Number of Lag Days to offset a child Task From a Parent Task or the Project. Actual Lag is computed based on this method and the setParentLagType(String). OPTIONAL

getParentLag

double getParentLag()

setParentLagType

void setParentLagType(java.lang.String val)

Sets the Parent Lag Type. See LagTypeEnum. OPTIONAL

getParentLagType

java.lang.String getParentLagType()

setTemplateID

void setTemplateID(int val)

TemplateBean ID. REQUIRED.

getTemplateID

int getTemplateID()

setRoleID

void setRoleID(int val)

RoleBean ID. REQUIRED.

getRoleID

int getRoleID()

setCategoryID

void setCategoryID(int val)

CategoryBean ID. OPTIONAL.

getCategoryID

int getCategoryID()

setMilestoneID

void setMilestoneID(int val)

MilestoneBean ID. OPTIONAL. User a null value when no Milestone is to be assigned. OPTIONAL.

getMilestoneID

int getMilestoneID()

setAssignedToID

void setAssignedToID(int val)

UserBean ID. Use a null value to leave the Task unassigned. OPTIONAL.

getAssignedToID

int getAssignedToID()

setParentID

void setParentID(int val)

TemplateTaskBean ID of this task's parent. Use a null value to make the Task a project top-level deliverable. OPTIONAL.

getParentID

int getParentID()

setIsRequired

void setIsRequired(boolean val)

Specifies whether a TemplateTask is added unconditionally to a Project created from this Template. REQUIRED.

getIsRequired

boolean getIsRequired()

setPredecessors

void setPredecessors(PredecessorBean[] val)

PredecessorBean[] that define a Tasks predecessors. OPTIONAL.

getPredecessors

PredecessorBean[] getPredecessors()

setStartDay

void setStartDay(double val)

StartDay can only be used if the TaskConstraint AddTaskMessage.setTaskConstraint(String) is set to "FIXT". In this constraint mode, @task scheduling is disabled for a TemplateTask and StartDay values must be provided. OPTIONAL.

getStartDay

double getStartDay()

setCompletionDay

void setCompletionDay(double val)

CompletionDay can only be used if the TaskConstraint AddTaskMessage.setTaskConstraint(String) is set to "FIXT". In this constraint mode, @task scheduling is disabled for a TemplateTask and CompletionDay values must be provided. OPTIONAL.

getCompletionDay

double getCompletionDay()

setAuditTypes

void setAuditTypes(java.lang.String[] vals)

Audit Types. Specifies what changes are logged for audit trail for Tasks created from this object. AuditTypeEnum

getAuditTypes

java.lang.String[] getAuditTypes()

setAssignments

void setAssignments(TemplateAssignmentBean[] val)

Controls ability to set assignments. Allows for multiple resources (Users and Roles) to be assigned to Template Tasks. Additional rules on this usage can be seen at BaseAssignmentBean.

getAssignments

TemplateAssignmentBean[] getAssignments()

setApprovalRequired

void setApprovalRequired(java.lang.String val)

Approval Required. Specifies whether an approval is required for a Task to be completed. A value of null will be ignored. This has to have an actual value to enforce a change. OPTIONAL.

getApprovalRequired

java.lang.String getApprovalRequired()

setApprovers

void setApprovers(ApproverBean[] val)

Approvers. ApproverBean. This collection defines the Users or Role that are required to Approve a Task to make in complete. OPTIONAL.

getApprovers

ApproverBean[] getApprovers()

setApproval

void setApproval(ApprovalBean val)

Approval Record. ApprovalBean. Defines the duration of the approval period as well as holds all dates associated with the approval process. If null this argument is ignored. OPTIONAL.

getApproval

ApprovalBean getApproval()

setRevenueType

void setRevenueType(java.lang.String val)

The Revenue Type of this task. Must be one of the statuses found in RevenueTypeEnum.

getRevenueType

java.lang.String getRevenueType()

setBillingAmount

void setBillingAmount(double val)

Billing Amount. Used in conjunction with Revenue Type to allow for different methods of revenue calculation OPTIONAL.

getBillingAmount

double getBillingAmount()

setCostType

void setCostType(java.lang.String val)

The Cost Type of this task. Must be one of the statuses found in CostTypeEnum.

getCostType

java.lang.String getCostType()

setCostAmount

void setCostAmount(double val)

Cost Amount. Used in conjunction with Cost Type to allow for different methods of cost calculation OPTIONAL.

getCostAmount

double getCostAmount()

setMasterTaskID

void setMasterTaskID(int val)

Master Task ID. If > 0, the Task linked to a Master Task in the system. Please note that this value is only used during Add operations. It is completely ignored in Edits. OPTIONAL.

getMasterTaskID

int getMasterTaskID()

getLevelingStartDelay

double getLevelingStartDelay()

Leveling Delays. Used in Resource Leveling. OPTIONAL.

setLevelingStartDelay

void setLevelingStartDelay(double val)

getLevelingStartDelayUnit

java.lang.String getLevelingStartDelayUnit()

setLevelingStartDelayUnit

void setLevelingStartDelayUnit(java.lang.String val)

getIsLevelingExcluded

boolean getIsLevelingExcluded()

setIsLevelingExcluded

void setIsLevelingExcluded(boolean val)

getForceEdit

boolean getForceEdit()

Force Edit.

setForceEdit

void setForceEdit(boolean val)

getRecurrenceRuleID

int getRecurrenceRuleID()

Recurrence Rule

setRecurrenceRuleID

void setRecurrenceRuleID(int val)

getRecurrenceRule

RecurrenceRuleBean getRecurrenceRule()

setRecurrenceRule

void setRecurrenceRule(RecurrenceRuleBean val)