com.starteam
Class Sprint

java.lang.Object
  com.starteam.TypedResource
      com.starteam.LiveObject
          com.starteam.TrackedObject
              com.starteam.VersionedObject
                  com.starteam.ViewMember
                      com.starteam.Item
                          com.starteam.Sprint

All Implemented Interfaces:

ISecurable, Lockable, LockableObject, java.lang.Cloneable

public class Sprint
extends Item

An Agile/Scrum Sprint is a basic unit of development. It sums up all work to be accomplished within the sprint period that typically spans from a week to a month.

Nested Class Summary

static class	Sprint.Type Type meta-data (schema) for Sprint object instances.
static class	Sprint.WebCacheSprint Item accessor for cached SDK Sprint items contained objects are obtained from the artifact cache

Nested classes/interfaces inherited from class com.starteam.Item

Item.WebCacheItem

Nested classes/interfaces inherited from class com.starteam.ViewMember

ViewMember.LockType, ViewMember.MyLock, ViewMember.ShareState, ViewMember.WebCacheViewMember

Nested classes/interfaces inherited from class com.starteam.VersionedObject

VersionedObject.WebCacheVersionedObject

Nested classes/interfaces inherited from class com.starteam.TrackedObject

TrackedObject.WebCacheTrackedObject

Nested classes/interfaces inherited from class com.starteam.LiveObject

LiveObject.WebCacheLiveObject

Nested classes/interfaces inherited from class com.starteam.TypedResource

TypedResource.BranchState

Method Summary

static Sprint	create(Folder prnt) Create a Sprint in the specified parent folder.
double	getCapacity(User u) return the capacity for the specified user
java.lang.String	getDescription() Returns the text in the "Description" property for this sprint.
Date	getEndDate() Returns the End Date of this sprint.
java.lang.String	getName() Returns the Name of this sprint.
User	getOwner() Returns the User object who owns this sprint.
Sprint.Type.PropertyCollection	getProperties() Gets the PropertyCollection for this Sprint.
int	getSprintID() Returns the sprint id.
Date	getStartDate() Returns the Start Date of this sprint.
Story[]	getStories() Returns the stories which are linked to this sprint.
View[]	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 u) Return true if this sprint has an assigned capacity for the specified user
void	setCapacity(User u, double capacity) set the capacity for a given user
void	setDescription(java.lang.String description) Sets the text in the "Description" property for this sprint.
void	setEndDate(Date dt) Set the End Date for this sprint.
void	setName(java.lang.String Name) Sets the Name of this sprint.
void	setOwner(User user) Sets the User who owns this sprint.
void	setStartDate(Date dt) Set the Start Date for this sprint.
void	setTargetReleases(View[] vv) set the target releases to which this sprint may map
void	setTeam(java.lang.String team) Sets the new team for this sprint.
void	update() Either stores this sprint in the server repository if new or modifies an existing sprint.

Methods inherited from class com.starteam.Item

copy, deleteMergePoint, getCommonAncestor, getDebugString, getDisplayableProperties, getItemID, getMergeHistory, getNewRevisionComment, getParentContainer, getParentFolder, getParentFolderHierarchy, getParentFolderName, getParentFolderPath, getParentFolderQualifiedName, getSharedChangePackages, getSharedTraces, isEqualTo, isReverseShareRecommended, moveTo, recordMergePoint, remove, resolve, resolveMergePoint, resolveMergePointEx, reverseShareTo, reverseShareTo, shareTo, smartShareTo, toString

Methods inherited from class com.starteam.ViewMember

equals, findLinks, getAllLabels, getAllShares, getAttachedLabels, getAttachments, getBehavior, getCache, getComment, getDeletedBy, getDeletedTime, getDisplayValue, getDotNotation, getExclusiveLocker, getExternalID, getExternalURL, getFromHistory, getFromHistory, getFromHistory, getFromHistory, getHistory, getID, getIntegerArrayValue, getLocker, getMyLockType, getParentRevision, getPresentationID, getRights, getRootObjectID, getShare, getShare, getTraces, getValue, getView, getViewMemberRevisions, getViewVersion, getVMID, hashCode, hasPermissions, isBookmarked, isBranchable, isDeleted, isDisembodied, isEqualTo, isReadOnly, isRootShare, isUnread, lockExclusive, lockExclusive, lockNonExclusive, modifyBookmark, modifyReadStatus, putLock, setAttachments, setBehavior, setBranchOnChange, setComment, setExternalID, setExternalURL, setFixedConfiguration, setFloatingConfiguration, setRights, setValue, unlock, updateRevisionComment

Methods inherited from class com.starteam.VersionedObject

getBranchRevision, getRevisionNumber, getViewVersion, isFromHistory

Methods inherited from class com.starteam.TrackedObject

getModifiedBy, getModifiedTime

Methods inherited from class com.starteam.LiveObject

getCreatedBy, getCreatedTime, toStarTeamURL

Methods inherited from class com.starteam.TypedResource

addToIntegerArray, getBooleanValue, getByteArrayValue, getCachedProperties, getContentValue, getDateTimeValue, getDateValue, getDisplayName, getDoubleValue, getEnumDisplayName, getEnumeratedValues, getIntegerValue, getLinkValue, getLongValue, getObjectID, getPossibleValues, getServer, getStringValue, getTimeSpanValue, getType, hasCachedProperties, hasValue, isDirty, isNew, removeFromIntegerArray, setBooleanValue, setByteArrayValue, setContentValue, setDateTimeValue, setDateValue, setDoubleValue, setEnumeratedValue, setEnumeratedValues, setIntegerArrayValue, setIntegerValue, setLinkValue, setLongValue, setStringValue, setTimeSpanValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.starteam.ISecurable

getServer, getType

Method Detail

create

public static Sprint create(Folder prnt)

Create a Sprint in the specified parent folder.

Parameters:

prnt - the parent folder

Returns:

a new Sprint Object.

getProperties

public Sprint.Type.PropertyCollection getProperties()

Gets the PropertyCollection for this Sprint.

Returns:

the PropertyCollection of its Type

getName

public java.lang.String getName()

Returns the Name of this sprint.

Returns:

the Name of this sprint.

See Also:

Sprint.Type.PropertyCollection.NAME

setName

public void setName(java.lang.String Name)

Sets the Name of this sprint.

Parameters:

Name - the new Name for this sprint.

See Also:

Sprint.Type.PropertyCollection.NAME

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

getDescription

public java.lang.String getDescription()

Returns the text in the "Description" property for this sprint.

Returns:

the text in the "Description" property for this sprint.

See Also:

Sprint.Type.PropertyCollection.DESCRIPTION

setDescription

public void setDescription(java.lang.String description)

Sets the text in the "Description" property for this sprint.

Parameters:

description - the text in the "Description" property for this sprint.

See Also:

Sprint.Type.PropertyCollection.DESCRIPTION

getOwner

public User 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.

getSprintID

public int getSprintID()

Returns the sprint id.

Returns:

the sprint id.

See Also:

Sprint.Type.PropertyCollection.SPRINT_ID

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.

setOwner

public void setOwner(User user)

Sets the User who owns this sprint.

Parameters:

user - the User who owns this sprint.

getStories

public Story[] getStories()

Returns the stories which are linked to this sprint.

Returns:

a possibly empty array of Story

setTargetReleases

public void setTargetReleases(View[] vv)

set the target releases to which this sprint may map

Parameters:

vv - the target releases to which this sprint may map

getTargetReleases

public View[] getTargetReleases()

return the target releases that this sprint may be mapped to

Returns:

the target releases that this sprint may be mapped to

hasCapacity

public boolean hasCapacity(User 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 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 u,
                        double capacity)

set the capacity for a given user

Parameters:

u - the user

capacity - the capacity to set

update

public void update()

Either stores this sprint in the server repository if new or modifies an existing sprint.

Overrides:

update in class ViewMember

See Also:

TypedResource.isNew()