com.starteam
Class Requirement.WebCacheRequirement

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.Requirement.WebCacheRequirement

All Implemented Interfaces:

ArtifactCacheManager.Securable

Enclosing class:

Requirement

public static class Requirement.WebCacheRequirement
extends TreeItem.WebCacheTreeItem

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

Method Summary

static Requirement.WebCacheRequirement	create(ArtifactCacheManager.Context cntxt, Folder.WebCacheFolder parent) Creates a Requirement on the server.
static Requirement.WebCacheRequirement	create(ArtifactCacheManager.Context cntxt, Requirement.WebCacheRequirement parent) Creates a Requirement on the server.
int	getAmbiguitiesCount() Return the number of ambiguities found for the requirement.
java.lang.String	getComments() Comments recorded for the requirement
int	getExpectedEffort() The estimated effort expected for completing the requirement.
int	getHighEffort() The Highest effort expected for completing the requirement.
int	getLowEffort() The lowest effort expected for completing the requirement.
TreeItem.MoSCoW	getMoSCoW() MoSCoW of the requirement
java.lang.String	getName() The name of the requirement
java.lang.String	getNotes() Notes recorded for the requirement
double	getOrder() Returns the order in which the requirement should be worked on.
User.WebCacheUser	getOwner() Owner of the requirement
Requirement.Priority	getPriority() Priority of the requirement
double	getRank() Returns this requirement's rank.
int	getRequirementNumber() Requirement number
Requirement.RequirementType	getRequirementType() Type of the requirement
User.WebCacheUser[]	getResponsibleUsers() The users responsible for the requirement.
User.WebCacheUser[]	getReviewedBy() Users who reviewed the requirement
java.lang.String	getRevisedDescription() Revised description for the requirement
Content.WebCacheContent	getRichDescription() Returns the rich description of this requirement.
Requirement.Status	getStatus() Returns the status (Draft, Submitted, Pending, Accepted, etc.) of the requirement.
Requirement.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
EnumeratedValue	getUDAGrouping() UDA Grouping of the requirement
void	setAmbiguitiesCount(int numAmbiguities) Set the number of ambiguities for the requirement.
void	setComments(java.lang.String comments) Set the comments recorded for the requirement
void	setExpectedEffort(int effort) The estimated effort expected for completing the requirement.
void	setHighEffort(int effort) The highest effort expected for completing the requirement.
void	setLowEffort(int effort) Set the lowest effort expected for completing the requirement.
void	setMoSCoW(TreeItem.MoSCoW moscow) Set the MoSCoW of the requirement
void	setName(java.lang.String name) Set the name for the requirement
void	setNotes(java.lang.String notes) Set the notes recorded for the requirement
void	setOrder(double order) Sets the new order in which the requirement should be worked on.
void	setOwner(User.WebCacheUser owner) Set the owner for the requirement
void	setPriority(Requirement.Priority priority) Set the priority of the requirement
void	setRank(double rank) Sets the new rank for this requirement.
void	setRequirementType(Requirement.RequirementType reqType) Set the type of the requirement
void	setResponsibleUsers(User.WebCacheUser[] responsibleUsers) Set the users responsible for the requirement.
void	setReviewedBy(User.WebCacheUser[] users) Set the users who reviewed the requirement
void	setRevisedDescription(java.lang.String revisedDesc) Set the revised description for the requirement
void	setRichDescription(Content.WebCacheContent description) Sets the rich description of this requirement.
void	setStatus(Requirement.Status status) Sets the status of the requirement.
void	setStreamState(Requirement.StreamState streamState) Sets the stream state of the Requirement
void	setTags(EnumeratedValue[] tags) sets the tags to be assigned to this story 0, 1 or more tags may be assigned or reassigned
void	setUDAGrouping(EnumeratedValue udaGrouping) Set the UDA Grouping of the requirement

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

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

create

public static Requirement.WebCacheRequirement create(ArtifactCacheManager.Context cntxt,
                                                     Requirement.WebCacheRequirement parent)

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

Returns:

the newly created Requirement.WebCacheRequirement, wrapping a new Requirement

setNotes

public void setNotes(java.lang.String notes)

Set the notes recorded for the requirement

Parameters:

notes - - notes recorded for the requirement

getNotes

public java.lang.String getNotes()

Notes recorded for the requirement

Returns:

the notes recorded for the requirement

getResponsibleUsers

public User.WebCacheUser[] getResponsibleUsers()

The users responsible for the requirement.

Returns:

the users responsible for the requirement

setResponsibleUsers

public void setResponsibleUsers(User.WebCacheUser[] responsibleUsers)

Set the users responsible for the requirement.

Parameters:

responsibleUsers - the users responsible for the requirement

getAmbiguitiesCount

public int getAmbiguitiesCount()

Return the number of ambiguities found for the requirement.

Returns:

the number of ambiguities found for the requirement.

setAmbiguitiesCount

public void setAmbiguitiesCount(int numAmbiguities)

Set the number of ambiguities for the requirement.

Parameters:

numAmbiguities - the number of ambiguities found for the requirement.

getExpectedEffort

public int getExpectedEffort()

The estimated effort expected for completing the requirement.

Returns:

the estimated effort expected for completing the requirement.

setExpectedEffort

public void setExpectedEffort(int effort)

The estimated effort expected for completing the requirement.

Parameters:

effort - the estimated effort expected for completing the requirement.

getHighEffort

public int getHighEffort()

The Highest effort expected for completing the requirement.

Returns:

the highest effort expected for completing the requirement.

setHighEffort

public void setHighEffort(int effort)

The highest effort expected for completing the requirement.

Parameters:

effort - the estimated effort expected.

getLowEffort

public int getLowEffort()

The lowest effort expected for completing the requirement.

Returns:

the minimum effort expected for completing the requirement.

setLowEffort

public void setLowEffort(int effort)

Set the lowest effort expected for completing the requirement.

Parameters:

effort - the minimum effort expected.

setOrder

public void setOrder(double order)

Sets the new order in which the requirement should be worked on. This property was introduced in 14.0 release of the server.

Parameters:

order - The new order for this requirement.

See Also:

Requirement.Type.PropertyCollection.ORDER

getOrder

public double getOrder()

Returns the order in which the requirement should be worked on.

Returns:

The order in which the requirement should be worked on.

See Also:

Requirement.Type.PropertyCollection.ORDER

setRank

public void setRank(double rank)

Sets the new rank for this requirement. This property was introduced in 14.0 release of the server.

Parameters:

rank - The new rank for this requirement.

See Also:

Requirement.Type.PropertyCollection.RANK

getRank

public double getRank()

Returns this requirement's rank.

Returns:

This requirement's rank.

See Also:

Requirement.Type.PropertyCollection.RANK

getName

public java.lang.String getName()

The name of the requirement

Returns:

the name of the requirement

setName

public void setName(java.lang.String name)

Set the name for the requirement

Parameters:

name - the name for the requirement

getComments

public java.lang.String getComments()

Comments recorded for the requirement

Returns:

the comments recorded for the requirement

setComments

public void setComments(java.lang.String comments)

Set the comments recorded for the requirement

Parameters:

comments - - comments recorded for the requirement

getOwner

public User.WebCacheUser getOwner()

Owner of the requirement

Returns:

the owner of the requirement

setOwner

public void setOwner(User.WebCacheUser owner)

Set the owner for the requirement

Parameters:

owner - - owner for the requirement

getPriority

public Requirement.Priority getPriority()

Priority of the requirement

Returns:

the priority of the requirement

setPriority

public void setPriority(Requirement.Priority priority)

Set the priority of the requirement

Parameters:

priority - - priority of the requirement

getRequirementNumber

public int getRequirementNumber()

Requirement number

Returns:

the requirement number

getRequirementType

public Requirement.RequirementType getRequirementType()

Type of the requirement

Returns:

the type of the requirement

setRequirementType

public void setRequirementType(Requirement.RequirementType reqType)

Set the type of the requirement

Parameters:

reqType - requirement type

getUDAGrouping

public EnumeratedValue getUDAGrouping()

UDA Grouping of the requirement

Returns:

the UDA Grouping of the requirement

setUDAGrouping

public void setUDAGrouping(EnumeratedValue udaGrouping)

Set the UDA Grouping of the requirement

Parameters:

udaGrouping - the grouping

getReviewedBy

public User.WebCacheUser[] getReviewedBy()

Users who reviewed the requirement

Returns:

the users who reviewed the requirement

setReviewedBy

public void setReviewedBy(User.WebCacheUser[] users)

Set the users who reviewed the requirement

Parameters:

users - who reviewed the requirement

getRevisedDescription

public java.lang.String getRevisedDescription()

Revised description for the requirement

Returns:

the revised description for the requirement

setRevisedDescription

public void setRevisedDescription(java.lang.String revisedDesc)

Set the revised description for the requirement

Parameters:

revisedDesc - revised description.

getStatus

public Requirement.Status getStatus()

Returns the status (Draft, Submitted, Pending, Accepted, etc.) of the requirement.

Returns:

The status (Draft, Submitted, Pending, Accepted, etc.) of the requirement.

See Also:

Requirement.Status, Requirement.Type.StatusProperty, Requirement.Type.PropertyCollection.STATUS

setStatus

public void setStatus(Requirement.Status status)

Sets the status of the requirement.

Parameters:

status - The new status for the requirement.

getStreamState

public Requirement.StreamState getStreamState()

Returns the Stream State

Returns:

streamState of this Requirement

See Also:

Requirement.Type.StreamStateProperty.NAME

setStreamState

public void setStreamState(Requirement.StreamState streamState)

Sets the stream state of the Requirement

Parameters:

streamState - the stream state of the Requirement

See Also:

Requirement.Type.StreamStateProperty.NAME

getRichDescription

public Content.WebCacheContent getRichDescription()

Returns the rich description of this requirement.

Returns:

the rich description of this requirement.

See Also:

TreeItem.Type.RichDescriptionProperty.NAME

setRichDescription

public void setRichDescription(Content.WebCacheContent description)

Sets the rich description of this requirement.

Parameters:

description - the new rich description for this requirement.

See Also:

TreeItem.Type.RichDescriptionProperty.NAME

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

getMoSCoW

public TreeItem.MoSCoW getMoSCoW()

MoSCoW of the requirement

Returns:

the MoSCoW of the requirement

setMoSCoW

public void setMoSCoW(TreeItem.MoSCoW moscow)

Set the MoSCoW of the requirement

Parameters:

moscow - MoSCoW