com.starteam
Class Task.WebCacheTask

java.lang.Object
  com.starteam.LiveObject.WebCacheLiveObject
      com.starteam.TrackedObject.WebCacheTrackedObject
          com.starteam.VersionedObject.WebCacheVersionedObject
              com.starteam.ViewMember.WebCacheViewMember
                  com.starteam.Item.WebCacheItem
                      com.starteam.TreeItem.WebCacheTreeItem
                          com.starteam.Task.WebCacheTask

All Implemented Interfaces:

ArtifactCacheManager.Securable

Enclosing class:

Task

public static class Task.WebCacheTask
extends TreeItem.WebCacheTreeItem

Item accessor for cached SDK Tasks contained objects are obtained from the artifact cache

Method Summary

void	addPredecessorLink(int predecessorID, int lagTime, int depType) Adds a new predecessor to this task.
void	addResource(User.WebCacheUser user) Adds the specified User object as a resource for this Task.
static Task.WebCacheTask	create(ArtifactCacheManager.Context cntxt, Folder.WebCacheFolder parent) Creates a Task on the server.
static Task.WebCacheTask	create(ArtifactCacheManager.Context cntxt, Task.WebCacheTask parent) Creates a Task on the server.
WorkRecord.WebCacheWorkRecord	createWorkRecord(User.WebCacheUser user) Creates a new WorkRecord for the specified Task and user.
Date	getActualFinishDate() Returns the actual finish date of this task.
Date	getActualStartDate() Returns the actual start date of this task.
TimeSpan	getActualWorkToDate() Returns the actual number of hours spent on this task.
java.lang.String	getAttentionNotes() Returns the text in the "Needs Attention" note for this task.
Task.Constraint	getConstraint() Returns the MS Project Constraint Type of this task.
DateTime	getConstraintDate() Returns the task's Constraint Date from MS Project.
java.lang.String	getDescription() Returns the description for this task.
Date	getEstimatedFinishDate() Returns the estimated date at which this task will be completed.
Date	getEstimatedStartDate() Returns the estimated start date of this task.
TimeSpan	getEstimatedTotalWork() Returns an estimate of the number of hours that will be spent completing this task.
Task.LifeCycleType	getLifeCycleType() Returns a value indicating the life cycle type (e.g.
java.lang.String	getMSProjectFileName() Returns the MS Project FileName of this task.
DateTime	getMSProjectLastUpdate() Returns the date that this task was last updated from MS Project.
java.lang.String	getName() Returns the Name of this task.
java.lang.String	getNotes() Returns the text in the "Notes" for this task.
int	getNumber() Returns the number assigned to this task.
double	getOrder() Returns the order in which the task should be worked on.
Story.WebCacheStory	getParentStory()
int	getPercentComplete() Returns a percentage indicating how much of the task has been completed.
TaskDependency.WebCacheTaskDependency[]	getPredecessorLinks() Returns the predecessor tasks to this this task.
Task.Priority	getPriority() Returns the Priority of this task.
User.WebCacheUser[]	getResources() Returns the User objects assigned as resources of this task.
User.WebCacheUser	getResponsibility() Returns The User object who is responsible for this task.
Content.WebCacheContent	getRichDescription() Returns the rich description of this task.
Task.Status	getStatus() Returns the Status of this task.
TaskDependency.WebCacheTaskDependency[]	getSuccessorLinks() Returns the successor tasks to this task.
java.lang.String	getTeam() Returns the team for this task.
int	getUniqueID() Returns the MS Project UniqueID of this task.
WorkRecord.WebCacheWorkRecord[]	getWorkRecords() Returns the work records associates with this task.
boolean	isBlocked() Returns a value indicating whether or not this task is blocked and needs further attention to resolve.
void	removeDependency(TaskDependency.WebCacheTaskDependency dependency) Removed the specified task dependency from this task.
void	removeResource(User.WebCacheUser user) Removes the specified User object as a resource from this task.
void	removeWorkRecord(WorkRecord.WebCacheWorkRecord record) Removes the work record from this task.
void	setActualFinishDate(Date ActualFinish) Sets the actual finish date of this task.
void	setActualStartDate(Date ActualStart) Sets the actual start date of this task.
void	setAttentionNotes(java.lang.String AttentionNotes) Sets the text in the "Needs Attention" note for this task.
void	setBlocked(boolean blocked) Sets the value indicating whether or not this task is blocked.
void	setDescription(java.lang.String description) Sets the new description for this task.
void	setEstimatedFinishDate(Date EstimatedFinish) Sets the estimated date at which this task will be completed.
void	setEstimatedStartDate(Date EstimatedStart) Sets the estimated start date of this task.
void	setEstimatedTotalWork(TimeSpan ts) Set the estimate of the number of hours that will be spent completing this task
void	setLifeCycleType(Task.LifeCycleType lifeCycleType) Sets the value indicating the life cycle type (e.g.
void	setName(java.lang.String Name) Sets the Name of this task.
void	setNotes(java.lang.String Notes) Sets the text in the "Notes" for this task.
void	setOrder(double order) Sets the new order in which the task should be worked on.
void	setPercentComplete(int PercentComplete) Sets the percentage indicating how much of the task has been completed.
void	setPriority(Task.Priority priority) Sets the Priority of this task.
void	setResponsibility(User.WebCacheUser user) Sets the User who is responsible for this task.
void	setRichDescription(Content.WebCacheContent description) Sets the rich description of this task.
void	setStatus(Task.Status status) Sets the Status of this task.
void	setTeam(java.lang.String team) Sets the new team for this task.

Methods inherited from class com.starteam.TreeItem.WebCacheTreeItem

create, create, getChildren, getParent, hasChildren, moveTo, setAfter, setBefore, setBetween, setFirst, setLast

Methods inherited from class com.starteam.Item.WebCacheItem

create, getLabels, getLinks, getParentFolder, moveTo, moveTo

Methods inherited from class com.starteam.ViewMember.WebCacheViewMember

getAttachments, getComment, getDisplayValue, getDotNotation, getExternalID, getExternalURL, getHistory, getLocker, getPresentationID, getRights, getShareTree, getTraces, getView, isDeleted, isFloating, isPinned, isUnread, lock, lock, modifyReadStatus, pinTo, setAttachments, setExternalID, setExternalURL, setRights, unlock, unpin, updateRevisionComment

Methods inherited from class com.starteam.VersionedObject.WebCacheVersionedObject

getRevisionNumber, getRootObjectID, getViewVersion, isFromHistory

Methods inherited from class com.starteam.TrackedObject.WebCacheTrackedObject

getModifiedBy, getModifiedTime

Methods inherited from class com.starteam.LiveObject.WebCacheLiveObject

addTo, equals, getContext, getCreatedBy, getCreatedTime, getDisplayName, getID, getObjectID, getServer, getType, getValue, getValue, hashCode, hasValue, isDirty, isNew, refresh, remove, removeFrom, setValue, setValue, toStarTeamURL, update

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Task.WebCacheTask create(ArtifactCacheManager.Context cntxt,
                                       Folder.WebCacheFolder parent)

Creates a Task on the server. This task may be saved by assigning the various properties and then calling update() on the WebCacheTask object, or it may be added to a WebCacheViewMemberCollection, which is then saved in a transacted context.

Parameters:

cntxt - the ArtifactCacheManager User Session Context

parent - the parent folder in which this new folder will be created. The parent folder should be from the artifact cache

Returns:

the newly created Task.WebCacheTask, wrapping a new Task

create

public static Task.WebCacheTask create(ArtifactCacheManager.Context cntxt,
                                       Task.WebCacheTask parent)

Creates a Task on the server. This item may be saved by assigning the various properties and then calling update() on the WebCacheTask object, or it may be added to a WebCacheViewMemberCollection, which is then saved in a transacted context.

Parameters:

cntxt - the ArtifactCacheManager User Session Context

parent - the parent Task to this new task . The parent task should be from the artifact cache

Returns:

the newly created Task.WebCacheTask, wrapping a new Task

addPredecessorLink

public void addPredecessorLink(int predecessorID,
                               int lagTime,
                               int depType)

Adds a new predecessor to this task.

Parameters:

predecessorID - the task id of the predecessor task

lagTime - the lag time for this dependency

depType - the dependency type.

createWorkRecord

public WorkRecord.WebCacheWorkRecord createWorkRecord(User.WebCacheUser user)

Creates a new WorkRecord for the specified Task and user.

Parameters:

user - the the user that performs the work

removeResource

public void removeResource(User.WebCacheUser user)

Removes the specified User object as a resource from this task.

Parameters:

user - the User object resource to remove from this task.

getResources

public User.WebCacheUser[] getResources()

Returns the User objects assigned as resources of this task.

Returns:

The User assigned as resources of this task.

See Also:

Task.Type.ResourcesProperty.NAME

addResource

public void addResource(User.WebCacheUser user)

Adds the specified User object as a resource for this Task.

Parameters:

user - the User object to add as a resource for this task,

getPredecessorLinks

public TaskDependency.WebCacheTaskDependency[] getPredecessorLinks()

Returns the predecessor tasks to this this task. The predecessors are represented by a TaskDependency object.

Returns:

The predecessor tasks to this this task.

getSuccessorLinks

public TaskDependency.WebCacheTaskDependency[] getSuccessorLinks()

Returns the successor tasks to this task. The successors are represented by a TaskDependency object.

Returns:

The successor tasks to this this task.

getWorkRecords

public WorkRecord.WebCacheWorkRecord[] getWorkRecords()

Returns the work records associates with this task.

Returns:

The work records associates with this task.

removeWorkRecord

public void removeWorkRecord(WorkRecord.WebCacheWorkRecord record)

Removes the work record from this task. The work record must already be associated with this task or an exception will be thrown.

Parameters:

record - the work record to be removed.

removeDependency

public void removeDependency(TaskDependency.WebCacheTaskDependency dependency)

Removed the specified task dependency from this task. The dependency must be either a successor or predecessor to this task or an exception will be thrown.

Parameters:

dependency - the task dependency to remove

getName

public java.lang.String getName()

Returns the Name of this task.

Returns:

The Name of this task.

See Also:

Task.Type.PropertyCollection.NAME

setDescription

public void setDescription(java.lang.String description)

Sets the new description for this task. This property was introduced in 12.0 release of the server.

Parameters:

description - The new description for this task.

See Also:

Task.Type.PropertyCollection.DESCRIPTION

getDescription

public java.lang.String getDescription()

Returns the description for this task. This property was introduced in 12.0 release of the server.

Returns:

The description for this task.

See Also:

Task.Type.PropertyCollection.DESCRIPTION

setTeam

public void setTeam(java.lang.String team)

Sets the new team for this task. This property was introduced in 14.0 release of the server.

Parameters:

team - The new team for this task.

See Also:

Task.Type.PropertyCollection.TEAM

getTeam

public java.lang.String getTeam()

Returns the team for this task. This property was introduced in 14.0 release of the server.

Returns:

The team for this task.

See Also:

Task.Type.PropertyCollection.TEAM

getRichDescription

public Content.WebCacheContent getRichDescription()

Returns the rich description of this task.

Returns:

the rich description of this task.

See Also:

TreeItem.Type.RichDescriptionProperty.NAME

setRichDescription

public void setRichDescription(Content.WebCacheContent description)

Sets the rich description of this task.

Parameters:

description - the new rich description for this task.

See Also:

TreeItem.Type.RichDescriptionProperty.NAME

setName

public void setName(java.lang.String Name)

Sets the Name of this task.

Parameters:

Name - The new Name for this task.

See Also:

Task.Type.PropertyCollection.NAME

getAttentionNotes

public java.lang.String getAttentionNotes()

Returns the text in the "Needs Attention" note for this task.

Returns:

The text in the "Needs Attention" note for this task.

See Also:

Task.Type.PropertyCollection.ATTENTION_NOTES

getMSProjectFileName

public java.lang.String getMSProjectFileName()

Returns the MS Project FileName of this task.

Returns:

The MS Project FileName of this task.

See Also:

Task.Type.MSProjectFileNameProperty.NAME

getActualWorkToDate

public TimeSpan getActualWorkToDate()

Returns the actual number of hours spent on this task.

Returns:

The actual number of hours spent on this task.

See Also:

Task.Type.ActualHoursProperty.NAME

getMSProjectLastUpdate

public DateTime getMSProjectLastUpdate()

Returns the date that this task was last updated from MS Project.

Returns:

The date that this task was last updated from MS Project.

See Also:

Task.Type.MSProjectLastUpdateProperty.NAME

getActualStartDate

public Date getActualStartDate()

Returns the actual start date of this task.

Returns:

The actual start date of this task.

See Also:

Task.Type.ActualStartProperty.NAME

setActualStartDate

public void setActualStartDate(Date ActualStart)

Sets the actual start date of this task.

Parameters:

ActualStart - The actual start date of this task.

getActualFinishDate

public Date getActualFinishDate()

Returns the actual finish date of this task.

Returns:

The actual finish date of this task.

See Also:

Task.Type.ActualFinishProperty.NAME

setActualFinishDate

public void setActualFinishDate(Date ActualFinish)

Sets the actual finish date of this task.

Parameters:

ActualFinish - The actual start date of this task.

getEstimatedFinishDate

public Date getEstimatedFinishDate()

Returns the estimated date at which this task will be completed.

Returns:

The estimated date at which this task will be completed.

See Also:

Task.Type.EstimatedFinishProperty.NAME

getEstimatedStartDate

public Date getEstimatedStartDate()

Returns the estimated start date of this task.

Returns:

The estimated start date of this task.

See Also:

Task.Type.EstimatedStartProperty.NAME

setEstimatedStartDate

public void setEstimatedStartDate(Date EstimatedStart)

Sets the estimated start date of this task.

Parameters:

EstimatedStart - The new estimated start date of this task.

setEstimatedFinishDate

public void setEstimatedFinishDate(Date EstimatedFinish)

Sets the estimated date at which this task will be completed.

Parameters:

EstimatedFinish - The new estimated date at which this task will be completed.

setAttentionNotes

public void setAttentionNotes(java.lang.String AttentionNotes)

Sets the text in the "Needs Attention" note for this task.

Parameters:

AttentionNotes - The text in the "Needs Attention" note for this task.

See Also:

Task.Type.PropertyCollection.ATTENTION_NOTES

getNotes

public java.lang.String getNotes()

Returns the text in the "Notes" for this task.

Returns:

The text in the "Notes" for this task.

See Also:

Task.Type.PropertyCollection.NOTES

setNotes

public void setNotes(java.lang.String Notes)

Sets the text in the "Notes" for this task.

Parameters:

Notes - The new Notes text for this task.

See Also:

Task.Type.PropertyCollection.NOTES

getPriority

public Task.Priority getPriority()

Returns the Priority of this task.

Returns:

The Priority of this task.

See Also:

Task.Type.PriorityProperty.NAME

getResponsibility

public User.WebCacheUser getResponsibility()

Returns The User object who is responsible for this task.

Returns:

The User object who is responsible for this task.

See Also:

Task.Type.ResponsibilityProperty.NAME

setResponsibility

public void setResponsibility(User.WebCacheUser user)

Sets the User who is responsible for this task.

Parameters:

user - The User who is responsible for this task.

setPriority

public void setPriority(Task.Priority priority)

Sets the Priority of this task.

Parameters:

priority - The new Priority for this task.

getStatus

public Task.Status getStatus()

Returns the Status of this task.

Returns:

The Status of this task.

See Also:

Task.Type.StatusProperty.NAME

setStatus

public void setStatus(Task.Status status)

Sets the Status of this task.

Parameters:

status - the new Status for this task.

See Also:

Task.Type.StatusProperty.NAME

getParentStory

public Story.WebCacheStory getParentStory()

Returns:

The story being set as parent of this or null

getLifeCycleType

public Task.LifeCycleType getLifeCycleType()

Returns a value indicating the life cycle type (e.g. Development, QA, Documentation or unknown) of this task. This property was introduced in 12.0 release of the server.

Returns:

A value indicating the lifecycle type (e.g., Development, QA, Documentation or unknown) of this task.

setLifeCycleType

public void setLifeCycleType(Task.LifeCycleType lifeCycleType)

Sets the value indicating the life cycle type (e.g. Development, QA, Documentation or unknown) of this task. This property was introduced in 12.0 release of the server.

Parameters:

lifeCycleType - the LifecycleType of this task

See Also:

Task.WebCacheTask.getLifeCycleType()

getPercentComplete

public int getPercentComplete()

Returns a percentage indicating how much of the task has been completed.

Returns:

A percentage indicating how much of the task has been completed.

See Also:

Task.Type.PropertyCollection.PERCENT_COMPLETE

setPercentComplete

public void setPercentComplete(int PercentComplete)

Sets the percentage indicating how much of the task has been completed.

Parameters:

PercentComplete - The new percentage indicating how much of the task has been completed.

isBlocked

public boolean isBlocked()

Returns a value indicating whether or not this task is blocked and needs further attention to resolve. This property was introduced in 12.0 release of the server.

Returns:

A value indicating whether or not this task is blocked

See Also:

Task.Type.PropertyCollection.BLOCKED

setBlocked

public void setBlocked(boolean blocked)

Sets the value indicating whether or not this task is blocked. This property was introduced in 12.0 release of the server.

Parameters:

blocked - The new value indicating whether or not this task is blocked

setOrder

public void setOrder(double order)

Sets the new order in which the task should be worked on. This property was introduced in 12.0 release of the server.

Parameters:

order - The new order for this task.

See Also:

Task.Type.PropertyCollection.ORDER

getOrder

public double getOrder()

Returns the order in which the task should be worked on.

Returns:

The order in which the task should be worked on.

See Also:

Task.Type.PropertyCollection.ORDER

getNumber

public int getNumber()

Returns the number assigned to this task.

Returns:

The number assigned to this task.

getUniqueID

public int getUniqueID()

Returns the MS Project UniqueID of this task.

Returns:

The MS Project UniqueID of this task.

getConstraint

public Task.Constraint getConstraint()

Returns the MS Project Constraint Type of this task.

Returns:

The MS Project Constraint Type of this task.

See Also:

Task.Type.ConstraintProperty.NAME

getConstraintDate

public DateTime getConstraintDate()

Returns the task's Constraint Date from MS Project.

Returns:

The task's Constraint Date from MS Project.

See Also:

Task.Type.ConstraintDateProperty.NAME

getEstimatedTotalWork

public TimeSpan getEstimatedTotalWork()

Returns an estimate of the number of hours that will be spent completing this task.

Returns:

An estimate of the number of hours that will be spent completing this task.

See Also:

Task.Type.PropertyCollection.ESTIMATED_HOURS

setEstimatedTotalWork

public void setEstimatedTotalWork(TimeSpan ts)

Set the estimate of the number of hours that will be spent completing this task

Parameters:

ts - an estimate of the number of hours