com.starteam
Class Story.WebCacheStory

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.Story.WebCacheStory

All Implemented Interfaces:

ArtifactCacheManager.Securable

Enclosing class:

Story

public static class Story.WebCacheStory
extends TreeItem.WebCacheTreeItem

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

Method Summary

static Story.WebCacheStory	create(ArtifactCacheManager.Context cntxt, Folder.WebCacheFolder parent) Creates a Story on the server.
static Story.WebCacheStory	create(ArtifactCacheManager.Context cntxt, Story.WebCacheStory parent) Creates a Story on the server.
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.
Sprint.WebCacheSprint	getParentSprint()
double	getRank() Returns the rank in which the story should be viewed.
Content.WebCacheContent	getRichDescription() Returns the rich description of this story.
Story.Risk	getRisk() Returns the risk for the story
User.WebCacheUser	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.WebCacheView[]	getTargetReleases() return the target releases that this story may be mapped to
Task.WebCacheTask[]	getTasks() Gets 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.WebCacheContent description) Sets the rich description of this story.
void	setRisk(Story.Risk risk) Sets the the risk for the story
void	setSponsor(User.WebCacheUser 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 stream state of 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.WebCacheView[] ww) set the target releases to which this story may map

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, getHistory, getLocker, getRights, getShareTree, getTraces, getView, isDeleted, isFloating, isPinned, isUnread, lock, lock, modifyReadStatus, pinTo, setAttachments, setRights, unlock, unpin, updateRevisionComent

Methods inherited from class com.starteam.VersionedObject.WebCacheVersionedObject

getDotNotation, getRevisionNumber, getRootObjectID, getViewVersion, isFromHistory

Methods inherited from class com.starteam.TrackedObject.WebCacheTrackedObject

getModifiedBy, getModifiedTime

Methods inherited from class com.starteam.LiveObject.WebCacheLiveObject

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

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Story.WebCacheStory create(ArtifactCacheManager.Context cntxt,
                                         Folder.WebCacheFolder parent)

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

create

public static Story.WebCacheStory create(ArtifactCacheManager.Context cntxt,
                                         Story.WebCacheStory parent)

Creates a Story on the server. This item may be saved by assigning the various properties and then calling update() on the WebCacheStory 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 Story to this new Story. The parent Story should be from the artifact cache

Returns:

the newly created Story, wrapping a new Story

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

getRichDescription

public Content.WebCacheContent getRichDescription()

Returns the rich description of this story.

Returns:

the rich description of this story.

See Also:

Story.Type.RichDescriptionProperty.NAME

setRichDescription

public void setRichDescription(Content.WebCacheContent description)

Sets the rich description of this story.

Parameters:

description - the new rich description for this story.

See Also:

Story.Type.RichDescriptionProperty.NAME

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

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.

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

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

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

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

getStreamState

public Story.StreamState getStreamState()

Returns the Stream State

Returns:

streamState of this story

See Also:

Story.Type.StreamStateProperty.NAME

setStreamState

public void setStreamState(Story.StreamState streamState)

Sets the stream state of the story

Parameters:

streamState - the stream state of the story

See Also:

Story.Type.StreamStateProperty.NAME

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

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.

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.

getSponsor

public User.WebCacheUser getSponsor()

Sponsor of the story

Returns:

the sponsor of the story

setSponsor

public void setSponsor(User.WebCacheUser sponsor)

Set the sponsor for the story.

Parameters:

sponsor - - sponsor for the story

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 instance

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 instance

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 instance

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 instance

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

getTasks

public Task.WebCacheTask[] getTasks()

Gets the tasks which are linked to this story.

Returns:

an array of WebCacheTask

getTargetReleases

public View.WebCacheView[] getTargetReleases()

return the target releases that this story may be mapped to

Returns:

the target releases that this story may be mapped to

setTargetReleases

public void setTargetReleases(View.WebCacheView[] ww)

set the target releases to which this story may map

Parameters:

ww - the target releases to which this story may map

getParentSprint

public Sprint.WebCacheSprint getParentSprint()

Returns:

The sprint being set as parent of this or null