com.starteam
Class Sprint.WebCacheSprint

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.Sprint.WebCacheSprint

All Implemented Interfaces:

ArtifactCacheManager.Securable

Enclosing class:

Sprint

public static class Sprint.WebCacheSprint
extends Item.WebCacheItem

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

Method Summary

static Sprint.WebCacheSprint	create(ArtifactCacheManager.Context cntxt, Folder.WebCacheFolder parent) Creates a Sprint on the server.
double	getCapacity(User.WebCacheUser u) return the capacity for the specified user
java.lang.String	getDescription() Returns the description of this sprint.
Date	getEndDate() Returns the End Date of this sprint.
java.lang.String	getName() Returns the name of this sprint.
User.WebCacheUser	getOwner() Returns the User object who owns this sprint.
int	getSprintID() Returns the sprint id.
Date	getStartDate() Returns the Start Date of this sprint.
Story.WebCacheStory[]	getStories() Gets the stories which are linked to this sprint.
View.WebCacheView[]	getTargetReleases() return the target releases that this sprint may be mapped to
java.lang.String	getTeam() Returns the team for this sprint.
boolean	hasCapacity(User.WebCacheUser u) Return true if this sprint has an assigned capacity for the specified user
void	setCapacity(User.WebCacheUser u, double capacity) set the capacity for a given user note that setting a capacity of 0 removes the capacity for that user
void	setDescription(java.lang.String description) set the description of the sprint
void	setEndDate(Date dt) Set the End Date for this sprint.
void	setName(java.lang.String name) set the name of the sprint
void	setOwner(User.WebCacheUser user) Sets the User who owns this sprint.
void	setStartDate(Date dt) Set the Start Date for this sprint.
void	setTargetReleases(View.WebCacheView[] ww) set the target releases to which this sprint may map
void	setTeam(java.lang.String team) Sets the new team for this sprint.

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 Sprint.WebCacheSprint create(ArtifactCacheManager.Context cntxt,
                                           Folder.WebCacheFolder parent)

Creates a Sprint on the server. This sprint may be saved by assigning the various properties and then calling update() on the WebCacheSprint 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 Sprint.WebCacheSprint, wrapping a new Sprint

getName

public java.lang.String getName()

Returns the name of this sprint.

Returns:

the name of this sprint.

See Also:

LiveObject.Type.NameProperty.NAME

setName

public void setName(java.lang.String name)

set the name of the sprint

Parameters:

name - set the name of the sprint

getDescription

public java.lang.String getDescription()

Returns the description of this sprint.

Returns:

the description of this sprint.

See Also:

LiveObject.Type.DescriptionProperty.NAME

setDescription

public void setDescription(java.lang.String description)

set the description of the sprint

Parameters:

description - set the description of the sprint

getStories

public Story.WebCacheStory[] getStories()

Gets the stories which are linked to this sprint.

Returns:

A possibly empty array of WebCacheStory

getOwner

public User.WebCacheUser getOwner()

Returns the User object who owns this sprint.

Returns:

the User object who owns this sprint.

See Also:

Sprint.Type.OwnerProperty.NAME

getStartDate

public Date getStartDate()

Returns the Start Date of this sprint.

Returns:

the Start Date of this sprint.

setStartDate

public void setStartDate(Date dt)

Set the Start Date for this sprint.

Parameters:

dt - The start date of the sprint

getEndDate

public Date getEndDate()

Returns the End Date of this sprint.

Returns:

the End Date of this sprint.

setEndDate

public void setEndDate(Date dt)

Set the End Date for this sprint.

Parameters:

dt - The end date of the sprint

setOwner

public void setOwner(User.WebCacheUser user)

Sets the User who owns this sprint.

Parameters:

user - the User who owns this sprint.

hasCapacity

public boolean hasCapacity(User.WebCacheUser u)

Return true if this sprint has an assigned capacity for the specified user

Parameters:

u - the user to test against

Returns:

true if this sprint has an assigned capacity for the specified user

getCapacity

public double getCapacity(User.WebCacheUser u)

return the capacity for the specified user

Parameters:

u - the user to test against

Returns:

the capacity for the specified user or -1 if the user has no capacity

setCapacity

public void setCapacity(User.WebCacheUser u,
                        double capacity)

set the capacity for a given user note that setting a capacity of 0 removes the capacity for that user

Parameters:

u - the user

capacity - the capacity to set

getSprintID

public int getSprintID()

Returns the sprint id.

Returns:

the sprint id.

See Also:

Sprint.Type.PropertyCollection.SPRINT_ID

setTeam

public void setTeam(java.lang.String team)

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

Parameters:

team - The new team for this sprint.

See Also:

Sprint.Type.PropertyCollection.TEAM

getTeam

public java.lang.String getTeam()

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

Returns:

The team for this sprint.

See Also:

Sprint.Type.PropertyCollection.TEAM

getTargetReleases

public View.WebCacheView[] getTargetReleases()

return the target releases that this sprint may be mapped to

Returns:

the target releases that this sprint may be mapped to

setTargetReleases

public void setTargetReleases(View.WebCacheView[] ww)

set the target releases to which this sprint may map

Parameters:

ww - the target releases to which this sprint may map