com.starteam
Class Sprint

java.lang.Object
  com.starteam.CacheRef
      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.
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.
Date	getStartDate() Returns the Start Date of this sprint.
Story[]	getStories() Returns the stories which are linked to this sprint.
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.

Methods inherited from class com.starteam.Item

copy, deleteMergePoint, getCommonAncestor, getDebugString, getDisplayableProperties, getItemID, getMergeHistory, getNewRevisionComment, getParentContainer, getParentFolder, getParentFolderHierarchy, getParentFolderName, getParentFolderPath, getParentFolderQualifiedName, isEqualTo, isReverseShareRecommended, isRootShare, 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, getDeletedBy, getDeletedTime, getDisplayValue, getExclusiveLocker, getFromHistory, getFromHistory, getFromHistory, getFromHistory, getHistory, getID, getIntegerArrayValue, getLocker, getMyLockType, getParentRevision, getRights, getRootObjectID, getShare, getShare, getTraces, getValue, getView, getViewMemberRevisions, getViewVersion, getVMID, hashCode, hasPermissions, isBookmarked, isBranchable, isDeleted, isDisembodied, isEqualTo, isReadOnly, isUnread, lockExclusive, lockExclusive, lockNonExclusive, modifyBookmark, modifyReadStatus, putLock, setAttachments, setBehavior, setBranchOnChange, setFixedConfiguration, setFloatingConfiguration, setRights, setValue, unlock, update, updateRevisionComment

Methods inherited from class com.starteam.VersionedObject

getBranchRevision, getComment, getDotNotation, getRevisionNumber, getViewVersion, isFromHistory, setComment

Methods inherited from class com.starteam.TrackedObject

getModifiedBy, getModifiedTime

Methods inherited from class com.starteam.LiveObject

getCreatedBy, getCreatedTime

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, isCachedProperty, isDirty, isNew, removeFromIntegerArray, setBooleanValue, setByteArrayValue, setContentValue, setDateTimeValue, setDateValue, setDoubleValue, setEnumeratedValue, setEnumeratedValues, setIntegerArrayValue, setIntegerValue, setLinkValue, setLongValue, setStringValue, setTimeSpanValue

Methods inherited from class com.starteam.CacheRef

clone

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

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.

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