com.starteam
Class Requirement

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

All Implemented Interfaces:

ISecurable, Lockable, LockableObject, java.lang.Cloneable

public class Requirement
extends TreeItem

Represents a StarTeam Requirement item.

Nested Class Summary

static class	Requirement.Priority Priority of the Requirement
static class	Requirement.RequirementType Type of the Requirement
static class	Requirement.Status Status of the Requirement
static class	Requirement.StreamState The Info Stream State of the Requirement
static class	Requirement.Type Type meta-data (schema) for Requirement object instances
static class	Requirement.WebCacheRequirement Item accessor for cached SDK Requirement items contained objects are obtained from the artifact cache

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

TreeItem.MoSCoW, 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

Requirement(Requirement parent)
Creates a new requirement that is a child of an existing requirement.

Method Summary

boolean	amIResponsible() Tests if the logged in user is responsible for the requirement
static Requirement	create(Folder prnt) Create a Requirement in the specified parent folder.
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() Return 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.
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.
User	getOwner() Owner of the requirement
Requirement.Priority	getPriority() Priority of the requirement
Requirement.Type.PropertyCollection	getProperties() Gets the PropertyCollection for this Requirement.
double	getRank() Returns this requirement's rank.
int	getRequirementNumber() Requirement number
Requirement.RequirementType	getRequirementType() Type of the requirement
User[]	getResponsibleUsers() The users responsible for the requirement.
User[]	getReviewedBy() Users who reviewed the requirement
java.lang.String	getRevisedDescription() Revised description for the requirement
Content	getRichDescription() Returns the Rich Description
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
boolean	hasParent() Tests if the Requirement has a parent
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 of 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 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[] responsibleUsers) Set the users responsible for the requirement.
void	setReviewedBy(User[] users) Set the users who reviewed the requirement
void	setRevisedDescription(java.lang.String revisedDesc) Set the revised description for the requirement
void	setRichDescription(Content cntnt) Sets the the Rich Description for the requirement This property was introduced in 14.0 release of the server.
void	setStatus(Requirement.Status status) Sets the status of the requirement.
void	setStreamState(Requirement.StreamState streamState) Sets the the Stream State for 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
java.lang.String	toString() Returns the notes of this requirement.

Methods inherited from class com.starteam.TreeItem

createChild, getChildren, getParent, getParentID, hasChildren, isEqualTo, 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, getSharedChangePackages, getSharedTraces, isEqualTo, isReverseShareRecommended, recordMergePoint, resolve, resolveMergePoint, resolveMergePointEx, reverseShareTo, reverseShareTo

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

Constructor Detail

Requirement

public Requirement(Requirement parent)

Creates a new requirement that is a child of an existing requirement.

Parameters:

parent - The parent requirement.

Method Detail

create

public static Requirement create(Folder prnt)

Create a Requirement in the specified parent folder.

Parameters:

prnt - the parent folder

Returns:

a new Requirement Object.

getProperties

public Requirement.Type.PropertyCollection getProperties()

Gets the PropertyCollection for this Requirement.

getResponsibleUsers

public User[] getResponsibleUsers()

The users responsible for the requirement.

Returns:

the users responsible for the requirement

setResponsibleUsers

public void setResponsibleUsers(User[] responsibleUsers)

Set the users responsible for the requirement.

Parameters:

responsibleUsers - the users responsible for the requirement

amIResponsible

public boolean amIResponsible()

Tests if the logged in user is responsible for the requirement

Returns:

true if the logged in user is responsible for the requirement.

hasParent

public boolean hasParent()

Tests if the Requirement has a parent

Returns:

true if the requirement has a parent.

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.

getNotes

public java.lang.String getNotes()

Notes recorded for the requirement

Returns:

the notes recorded for the requirement

getComments

public java.lang.String getComments()

Comments recorded for the requirement

Returns:

the comments recorded for the requirement

setNotes

public void setNotes(java.lang.String notes)

Set the notes recorded for the requirement

Parameters:

notes - - notes 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

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 requirements rank

See Also:

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

getName

public java.lang.String getName()

Return the name of the requirement

Returns:

the name of the requirement

setName

public void setName(java.lang.String name)

set the name of the requirement

Parameters:

name - the name of the requirement

getRichDescription

public Content getRichDescription()

Returns the Rich Description

Returns:

Rich Description used for this requirement

See Also:

TreeItem.Type.RichDescriptionProperty.NAME

setRichDescription

public void setRichDescription(Content cntnt)

Sets the the Rich Description for the requirement This property was introduced in 14.0 release of the server.

Parameters:

cntnt - the Content

See Also:

TreeItem.Type.RichDescriptionProperty.NAME

getOwner

public User getOwner()

Owner of the requirement

Returns:

the owner of the requirement

setOwner

public void setOwner(User 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

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

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[] getReviewedBy()

Users who reviewed the requirement

Returns:

the users who reviewed the requirement

setReviewedBy

public void setReviewedBy(User[] 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:

Stream State used for this requirement

See Also:

Requirement.Type.StreamStateProperty.NAME

setStreamState

public void setStreamState(Requirement.StreamState streamState)

Sets the the Stream State for the Requirement

Parameters:

streamState - the Stream State

See Also:

Requirement.Type.StreamStateProperty.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

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

toString

public java.lang.String toString()

Returns the notes of this requirement.

Overrides:

toString in class Item

Returns:

the notes of this requirement.