com.starteam
Class Story

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.TreeItem
                                  com.starteam.Story

All Implemented Interfaces:

ISecurable, Lockable, LockableObject, java.lang.Cloneable

public class Story
extends TreeItem

A Story represents an Agile user story. It has a StoryType property to further qualify it as a more specific Agile artifact like Epic, Theme ... . Stories can be hierarchical, that is a parent story can have child stories. Stories may have Tasks to break them up into smaller units of work.

Nested Class Summary

static class	Story.EstimatedPoints The Estimated Points of this story
static class	Story.Risk Risk of the Story
static class	Story.Status The status of this story
static class	Story.StoryType The type of the story according to agile terminology.
static class	Story.StoryValue Value of the Story
static class	Story.StreamState The Info Stream State of the Story
static class	Story.Type Type meta-data (schema) for Story object instances.
static class	Story.WebCacheStory Item accessor for cached SDK Story items contained objects are obtained from the artifact cache

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

TreeItem.WebCacheTreeItem

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

Constructor Summary

Story(Story parent)
Creates a child-Story under this parent Story.

Method Summary

static Story	create(Folder prnt) Create a Story in the specified parent folder.
java.lang.String	getAcceptanceCriteria() Returns the text in the "AcceptanceCriteria" for this story.
java.lang.String	getDescription() Returns the description of this story.
Story.EstimatedPoints	getEstimatedPoints() Returns a estimated points indicating how long it might take for the story to be completed.
EnumeratedValue[]	getIncomingStreams() returns the incoming streams, if any, attached to this story the returned array may be of size 0, but is never null
java.lang.String	getName() Returns the Name of this story.
java.lang.String	getNotes() Returns the text in the "Notes" for this story.
double	getOrder() Returns the order in which the story should be executed.
DoubleProperty	getOrderProperty() Returns a DoubleProperty used for ordering tree item instances Any TreeItem Type that intends to have the children of a particular parent ordered using a default numeric scheme must provide a double property to store the implicit order.
Sprint	getParentSprint() Returns the sprint which owns this story.
Story.Type.PropertyCollection	getProperties() Gets the PropertyCollection for this Story.
double	getRank() Returns the rank in which the story should be viewed.
Content	getRichDescription() Returns the Rich Description
Story.Risk	getRisk() Returns the risk for the story
User	getSponsor() Sponsor of the story
Story.Status	getStatus() Gets the status of a story based on the statuses of the tasks under that story.
Story.StoryType	getStoryType() Returns the story type
Story.StoryValue	getStoryValue() Returns the story value
Story.StreamState	getStreamState() Returns the Stream State
EnumeratedValue[]	getTags() returns the tags, if any, attached to this story the returned array may be of size 0, but is never null
View[]	getTargetReleases() return the target releases that this story may be mapped to
Task[]	getTasks() Returns the tasks which are linked to this story.
void	setAcceptanceCriteria(java.lang.String acceptanceCriteria) Sets the text in the "AcceptanceCriteria" for this story.
void	setDescription(java.lang.String description) Sets the description of this story.
void	setEstimatedPoints(Story.EstimatedPoints estmtdPnts) Sets the estimated points indicating how long it might take for the story to be completed.
void	setIncomingStreams(EnumeratedValue[] streams) sets the incoming streams to be assigned to this story 0, 1 or more incoming streams may be assigned or reassigned
void	setName(java.lang.String name) Sets the Name of this story.
void	setNotes(java.lang.String notes) Sets the text in the "Notes" for this story.
void	setOrder(double storyOrder) Sets the order in which the story should be executed.
void	setRank(double rank) Sets the rank in which the story should be viewed.
void	setRichDescription(Content cntnt) Sets the the Rich Description for the story
void	setRisk(Story.Risk risk) Sets the the risk for the story
void	setSponsor(User sponsor) Set the sponsor for the story.
void	setStoryType(Story.StoryType storyType) Sets the the story type for the story
void	setStoryValue(Story.StoryValue storyValue) Sets the story value of the story
void	setStreamState(Story.StreamState streamState) Sets the the Stream State for the story
void	setTags(EnumeratedValue[] tags) sets the tags to be assigned to this story 0, 1 or more tags may be assigned or reassigned
void	setTargetReleases(View[] vv) set the target releases to which this story may map

Methods inherited from class com.starteam.TreeItem

createChild, getChildren, getParent, getParentID, hasChildren, moveTo, moveTo, remove, setAfter, setBefore, setBetween, setFirst, setLast, shareTo, smartShareTo, update

Methods inherited from class com.starteam.Item

copy, deleteMergePoint, getCommonAncestor, getDebugString, getDisplayableProperties, getItemID, getMergeHistory, getNewRevisionComment, getParentContainer, getParentFolder, getParentFolderHierarchy, getParentFolderName, getParentFolderPath, getParentFolderQualifiedName, isEqualTo, isReverseShareRecommended, isRootShare, recordMergePoint, resolve, resolveMergePoint, resolveMergePointEx, reverseShareTo, reverseShareTo, 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, 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

Constructor Detail

Story

public Story(Story parent)

Creates a child-Story under this parent Story.

Parameters:

parent -

Method Detail

create

public static Story create(Folder prnt)

Create a Story in the specified parent folder.

Parameters:

prnt - the parent folder

Returns:

a new Story Object.

getProperties

public Story.Type.PropertyCollection getProperties()

Gets the PropertyCollection for this Story.

Returns:

the PropertyCollection of its Type

getName

public java.lang.String getName()

Returns the Name of this story.

Returns:

the Name of this story.

See Also:

Story.Type.PropertyCollection.NAME

setName

public void setName(java.lang.String name)

Sets the Name of this story.

Parameters:

name - the new Name for this story.

See Also:

Story.Type.PropertyCollection.NAME

getDescription

public java.lang.String getDescription()

Returns the description of this story.

Returns:

the description of this story.

See Also:

LiveObject.Type.DescriptionProperty.NAME

setDescription

public void setDescription(java.lang.String description)

Sets the description of this story.

Parameters:

description - the new description for this story.

See Also:

LiveObject.Type.DescriptionProperty.NAME

getStoryType

public Story.StoryType getStoryType()

Returns the story type

Returns:

story type used for this story

See Also:

Story.Type.StoryTypeProperty.NAME

setStoryType

public void setStoryType(Story.StoryType storyType)

Sets the the story type for the story

Parameters:

storyType - the story type

See Also:

Story.Type.StoryTypeProperty.NAME

getStreamState

public Story.StreamState getStreamState()

Returns the Stream State

Returns:

Stream State used for this story

See Also:

Story.Type.StreamStateProperty.NAME

setStreamState

public void setStreamState(Story.StreamState streamState)

Sets the the Stream State for the story

Parameters:

streamState - the Stream State

See Also:

Story.Type.StreamStateProperty.NAME

getRichDescription

public Content getRichDescription()

Returns the Rich Description

Returns:

Rich Description used for this story

See Also:

Story.Type.RichDescriptionProperty.NAME

setRichDescription

public void setRichDescription(Content cntnt)

Sets the the Rich Description for the story

Parameters:

cntnt - the Content

See Also:

Story.Type.RichDescriptionProperty.NAME

setTargetReleases

public void setTargetReleases(View[] vv)

set the target releases to which this story may map

Parameters:

vv - the target releases to which this story may map

getTargetReleases

public View[] getTargetReleases()

return the target releases that this story may be mapped to

Returns:

the target releases that this story may be mapped to

getRisk

public Story.Risk getRisk()

Returns the risk for the story

Returns:

risk used for this story

See Also:

Story.Type.RiskProperty.NAME

setRisk

public void setRisk(Story.Risk risk)

Sets the the risk for the story

Parameters:

risk - the risk for the story

See Also:

Story.Type.RiskProperty.NAME

getStoryValue

public Story.StoryValue getStoryValue()

Returns the story value

Returns:

storyValue of this story

See Also:

Story.Type.StoryValueProperty.NAME

setStoryValue

public void setStoryValue(Story.StoryValue storyValue)

Sets the story value of the story

Parameters:

storyValue - the story value of the story

See Also:

Story.Type.StoryValueProperty.NAME

getEstimatedPoints

public Story.EstimatedPoints getEstimatedPoints()

Returns a estimated points indicating how long it might take for the story to be completed.

Returns:

A estimated points indicating how long it might take for the story to be completed.

See Also:

Story.Type.PropertyCollection.ESTIMATED_POINTS

setEstimatedPoints

public void setEstimatedPoints(Story.EstimatedPoints estmtdPnts)

Sets the estimated points indicating how long it might take for the story to be completed.

Parameters:

estmtdPnts - The new estimated points indicating how long it might take for the story to be completed.

getOrder

public double getOrder()

Returns the order in which the story should be executed.

Returns:

the order in which the story should be executed.

See Also:

Story.Type.PropertyCollection.STORY_ORDER

getRank

public double getRank()

Returns the rank in which the story should be viewed.

Returns:

the rank in which the story should be viewed.

See Also:

Story.Type.PropertyCollection.RANK

getOrderProperty

public DoubleProperty getOrderProperty()

Returns a DoubleProperty used for ordering tree item instances Any TreeItem Type that intends to have the children of a particular parent ordered using a default numeric scheme must provide a double property to store the implicit order. Order is computed by aggregating and dividing the order of the precedent and antecedent tree items w.r.t. the one being ordered

Overrides:

getOrderProperty in class TreeItem

Returns:

a DoubleProperty used for ordering tree item instances

setOrder

public void setOrder(double storyOrder)

Sets the order in which the story should be executed.

Parameters:

storyOrder - the order in which the story should be executed.

setRank

public void setRank(double rank)

Sets the rank in which the story should be viewed.

Parameters:

rank - the rank in which the story should be viewed.

getAcceptanceCriteria

public java.lang.String getAcceptanceCriteria()

Returns the text in the "AcceptanceCriteria" for this story.

Returns:

the text in the "AcceptanceCriteria" for this story.

See Also:

Story.Type.PropertyCollection.ACCEPTANCE_CRITERIA

setAcceptanceCriteria

public void setAcceptanceCriteria(java.lang.String acceptanceCriteria)

Sets the text in the "AcceptanceCriteria" for this story.

Parameters:

acceptanceCriteria - The new AcceptanceCriteria text for this story.

See Also:

Story.Type.PropertyCollection.ACCEPTANCE_CRITERIA

getNotes

public java.lang.String getNotes()

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

Returns:

the text in the "Notes" for this story.

See Also:

Story.Type.PropertyCollection.NOTES

setNotes

public void setNotes(java.lang.String notes)

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

Parameters:

notes - the new Notes text for this story.

See Also:

Story.Type.PropertyCollection.NOTES

getTags

public EnumeratedValue[] getTags()

returns the tags, if any, attached to this story the returned array may be of size 0, but is never null

Returns:

the tags, if any attached to this story

setTags

public void setTags(EnumeratedValue[] tags)

sets the tags to be assigned to this story 0, 1 or more tags may be assigned or reassigned

Parameters:

tags - the tags to be assigned to this story

getIncomingStreams

public EnumeratedValue[] getIncomingStreams()

returns the incoming streams, if any, attached to this story the returned array may be of size 0, but is never null

Returns:

the incoming streams, if any attached to this story

setIncomingStreams

public void setIncomingStreams(EnumeratedValue[] streams)

sets the incoming streams to be assigned to this story 0, 1 or more incoming streams may be assigned or reassigned

Parameters:

streams - the incoming streams to be assigned to this story

getSponsor

public User getSponsor()

Sponsor of the story

Returns:

the sponsor of the story

setSponsor

public void setSponsor(User sponsor)

Set the sponsor for the story.

Parameters:

sponsor - - sponsor for the story

getTasks

public Task[] getTasks()

Returns the tasks which are linked to this story.

Returns:

a possibly empty array of Task

getStatus

public Story.Status getStatus()

Gets the status of a story based on the statuses of the tasks under that story.

Returns:

A status reflecting the statuses of its tasks

getParentSprint

public Sprint getParentSprint()

Returns the sprint which owns this story.

Returns:

the Sprint being set as its parent by trace or null.