com.starteam
Class ChangeRequest

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

All Implemented Interfaces:

ISecurable, Lockable, LockableObject, java.lang.Cloneable

public class ChangeRequest
extends Item

Represents a StarTeam ChangeRequest item.

Nested Class Summary

static class	ChangeRequest.ChangeRequestType The type of change requested.
static class	ChangeRequest.Platform The platform on which the need for this request was discovered.
static class	ChangeRequest.Priority Priority of the ChangeRequest
static class	ChangeRequest.Severity The severity of the problem that prompted the request.
static class	ChangeRequest.Status The current status of the change request.
static class	ChangeRequest.StreamState The Info Stream State of the ChangeRequest
static class	ChangeRequest.Type Type meta-data (schema) for ChangeRequest object instances.
static class	ChangeRequest.WebCacheChangeRequest Item accessor for cached SDK ChangeRequest 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 ChangeRequest	create(Folder prnt) Create a ChangeRequest in the specified parent folder.
User	getAddressedBy() Returns the User object that addressed this request.
Label	getAddressedIn() Returns a label representing the build or named configuration that this request was addressed in.
View	getAddressedInView() Returns the view from which this Change Request was addressed.
java.lang.String	getCategory() Returns the category of this request.
DateTime	getClosedOn() Returns the date that this request was given a closed status.
java.lang.String	getComponent() Returns the component this request applies to.
java.lang.String	getDescription() Returns the description of this change request.
User	getEnteredBy() Returns the User object that entered this request.
DateTime	getEnteredOn() Returns the date that this request was entered
java.lang.String	getExternalReference() Returns a string value that represents some external reference, such as an identification number identifying this request in another system.
java.lang.String	getFix() Returns the fix for this change request.
Label	getLastBuildTested() Returns a label of the build or named configuration that this request was last tested in.
int	getNumber() Returns the numeric identifier of this change request in the StarTeam view.
ChangeRequest.Platform	getPlatform() Returns the platform this Change Request applies to.
ChangeRequest.Priority	getPriority() Returns the relative priority of this Change Request.
ChangeRequest.Type.PropertyCollection	getProperties() Gets the PropertyCollection for this ChangeRequest.
ChangeRequest.ChangeRequestType	getRequestType() Returns this change request's type.
DateTime	getResolvedOn() Returns the date that this Change Request was resolved.
User	getResponsibility() Returns the User object that is currently responsible for this request.
ChangeRequest.Severity	getSeverity() Return the relative severity of the condition that this Change Request represents.
ChangeRequest.Status	getStatus() Returns the status (Open, Fixed, Closed, etc.) of this Change Request.
ChangeRequest.StreamState	getStreamState() Returns the Stream State
java.lang.String	getSynopsis() Returns the synopsis or brief description of this request.
java.lang.String	getTestCommand() Returns the test command string for this change request.
DateTime	getVerifiedOn() Returns the date that this Change Request was verified.
java.lang.String	getWorkAround() Returns the workaround for this change request.
void	setAddressedBy(User user) Sets the User object that addressed this request.
void	setAddressedIn(Label label) Sets the label in which this change request was addressed.
void	setAddressedInView(View view) Sets the view from which this Change Request was addressed.
void	setCategory(java.lang.String category) Sets the category for this change request.
void	setComponent(java.lang.String component) Sets the component this change request applies to.
void	setDescription(java.lang.String description) Sets the description of this change request.
void	setEnteredBy(User user) Sets the User object that entered this request.
void	setExternalReference(java.lang.String reference) Sets the external reference for this change request.
void	setFix(java.lang.String fix) Sets the fix for this change request.
void	setLastBuildTested(Label label) Sets the label for the build in which the change request was last tested.
void	setPlatform(ChangeRequest.Platform platform) Sets the platform this change request applies to.
void	setPriority(ChangeRequest.Priority priority) Sets the priority of this change request.
void	setRequestType(ChangeRequest.ChangeRequestType type) Sets this change request's type.
void	setResponsibility(User user) Sets the responsibility of this change request to the specified User object.
void	setSeverity(ChangeRequest.Severity severity) Sets the severity for this change request.
void	setStatus(ChangeRequest.Status status) Sets the status of this change request.
void	setStreamState(ChangeRequest.StreamState streamState) Sets the the Stream State for the change request
void	setSynopsis(java.lang.String synopsis) Sets the synopsis for this change request.
void	setTestCommand(java.lang.String testCommand) Sets the test command for this change request.
void	setWorkAround(java.lang.String workAround) Sets the workaround for this change request.
java.lang.String	toString() Returns the Number of this Change Request.

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, moveTo, recordMergePoint, remove, resolve, resolveMergePoint, resolveMergePointEx, reverseShareTo, reverseShareTo, shareTo, smartShareTo

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, update, 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

Method Detail

create

public static ChangeRequest create(Folder prnt)

Create a ChangeRequest in the specified parent folder.

Parameters:

prnt - the parent folder

Returns:

a new ChangeRequest Object.

getProperties

public ChangeRequest.Type.PropertyCollection getProperties()

Gets the PropertyCollection for this ChangeRequest.

getExternalReference

public java.lang.String getExternalReference()

Returns a string value that represents some external reference, such as an identification number identifying this request in another system.

Returns:

the external reference field for this change request

See Also:

Item.Type.ExternalReferenceProperty.NAME

setExternalReference

public void setExternalReference(java.lang.String reference)

Sets the external reference for this change request.

Parameters:

reference - the new external reference value for this change request

getNumber

public int getNumber()

Returns the numeric identifier of this change request in the StarTeam view.

Returns:

this change requests CR#

See Also:

ChangeRequest.Type.ChangeNumberProperty.NAME

getSynopsis

public java.lang.String getSynopsis()

Returns the synopsis or brief description of this request.

Returns:

the synopsis or brief description of this request.

See Also:

ChangeRequest.Type.SynopsisProperty.NAME

setSynopsis

public void setSynopsis(java.lang.String synopsis)

Sets the synopsis for this change request.

Parameters:

synopsis - the new synopsis for this change request

See Also:

ChangeRequest.Type.SynopsisProperty.NAME

getRequestType

public ChangeRequest.ChangeRequestType getRequestType()

Returns this change request's type. The type denotes whether this request is a defect report or a feature enhancement.

Returns:

This change request's type. The type denotes whether this request is a defect report or a feature enhancement.

See Also:

ChangeRequest.Type.ChangeRequestTypeProperty.NAME, ChangeRequest.Type.ChangeRequestTypeProperty.NAME

setRequestType

public void setRequestType(ChangeRequest.ChangeRequestType type)

Sets this change request's type.

Parameters:

type - The new type for this change request.

getStatus

public ChangeRequest.Status getStatus()

Returns the status (Open, Fixed, Closed, etc.) of this Change Request.

Returns:

The status (Open, Fixed, Closed, etc.) of this Change Request.

See Also:

ChangeRequest.Status, ChangeRequest.Type.StatusProperty, ChangeRequest.Type.PropertyCollection.STATUS

setStatus

public void setStatus(ChangeRequest.Status status)

Sets the status of this change request.

Parameters:

status - The new status value for this change request.

getStreamState

public ChangeRequest.StreamState getStreamState()

Returns the Stream State

Returns:

Stream State used for this change request

See Also:

ChangeRequest.Type.StreamStateProperty.NAME

setStreamState

public void setStreamState(ChangeRequest.StreamState streamState)

Sets the the Stream State for the change request

Parameters:

streamState - the Stream State

See Also:

ChangeRequest.Type.StreamStateProperty.NAME

getSeverity

public ChangeRequest.Severity getSeverity()

Return the relative severity of the condition that this Change Request represents.

Returns:

The relative severity of the condition that this Change Request represents.

See Also:

ChangeRequest.Severity, ChangeRequest.Type.SeverityProperty, ChangeRequest.Type.PropertyCollection.SEVERITY

setSeverity

public void setSeverity(ChangeRequest.Severity severity)

Sets the severity for this change request.

Parameters:

severity - The new severity value for this change request.

getAddressedIn

public Label getAddressedIn()

Returns a label representing the build or named configuration that this request was addressed in. This only applies to requests that are in a resolved state.

Returns:

the label for the build in which this request was addressed

See Also:

ChangeRequest.Type.AddressedInProperty.NAME

setAddressedIn

public void setAddressedIn(Label label)

Sets the label in which this change request was addressed. To indicate that it will be addressed in the next build you need to specify the value Label.NEXT_BUILD

Parameters:

label - the label of the build in which this change request is addressed

See Also:

Label.NEXT_BUILD

getEnteredBy

public User getEnteredBy()

Returns the User object that entered this request.

Returns:

the User object that entered this request.

See Also:

ChangeRequest.Type.EnteredByProperty.NAME

setEnteredBy

public void setEnteredBy(User user)

Sets the User object that entered this request.

Parameters:

user - User object that entered this request.

getAddressedBy

public User getAddressedBy()

Returns the User object that addressed this request.

Returns:

the User object that addressed this request.

See Also:

ChangeRequest.Type.AddressedByProperty.NAME

setAddressedBy

public void setAddressedBy(User user)

Sets the User object that addressed this request.

Parameters:

user - User object that addressed this request.

getAddressedInView

public View getAddressedInView()

Returns the view from which this Change Request was addressed.

Returns:

The view from which this Change Request was addressed.

See Also:

ChangeRequest.Type.AddressedInViewProperty.NAME

setAddressedInView

public void setAddressedInView(View view)

Sets the view from which this Change Request was addressed.

Parameters:

view - The new view.

getLastBuildTested

public Label getLastBuildTested()

Returns a label of the build or named configuration that this request was last tested in.

Returns:

a label of the build or named configuration that this request was last tested in.

See Also:

ChangeRequest.Type.LastBuildTestedProperty.NAME

setLastBuildTested

public void setLastBuildTested(Label label)

Sets the label for the build in which the change request was last tested.

Parameters:

label - the label for the last build in which the change request was tested

getResponsibility

public User getResponsibility()

Returns the User object that is currently responsible for this request.

Returns:

the User object that is currently responsible for this request.

See Also:

ViewMember.Type.ResponsibilityProperty.NAME

setResponsibility

public void setResponsibility(User user)

Sets the responsibility of this change request to the specified User object.

Parameters:

user - the User object responsible for this request

getPriority

public ChangeRequest.Priority getPriority()

Returns the relative priority of this Change Request.

Returns:

The relative priority of this Change Request.

See Also:

ChangeRequest.Type.PriorityProperty, ChangeRequest.Type.PropertyCollection.PRIORITY

setPriority

public void setPriority(ChangeRequest.Priority priority)

Sets the priority of this change request.

Parameters:

priority - The new priority for this change request.

getDescription

public java.lang.String getDescription()

Returns the description of this change request.

Returns:

the description of this change request.

See Also:

LiveObject.Type.DescriptionProperty.NAME

setDescription

public void setDescription(java.lang.String description)

Sets the description of this change request.

Parameters:

description - the new description for this change request.

See Also:

LiveObject.Type.DescriptionProperty.NAME

getPlatform

public ChangeRequest.Platform getPlatform()

Returns the platform this Change Request applies to.

Returns:

The platform this Change Request applies to.

See Also:

ChangeRequest.Platform, ChangeRequest.Type.PlatformProperty.NAME

setPlatform

public void setPlatform(ChangeRequest.Platform platform)

Sets the platform this change request applies to.

Parameters:

platform - The new platform this change request applies to.

getCategory

public java.lang.String getCategory()

Returns the category of this request.

Returns:

the category of this request.

See Also:

ChangeRequest.Type.CategoryProperty.NAME

setCategory

public void setCategory(java.lang.String category)

Sets the category for this change request.

Parameters:

category - the new category for this change request

See Also:

ChangeRequest.Type.CategoryProperty.NAME

getComponent

public java.lang.String getComponent()

Returns the component this request applies to.

Returns:

the component this request applies to.

See Also:

ChangeRequest.Type.ComponentProperty.NAME

setComponent

public void setComponent(java.lang.String component)

Sets the component this change request applies to.

Parameters:

component - the new component this change request applies to

See Also:

ChangeRequest.Type.ComponentProperty.NAME

getTestCommand

public java.lang.String getTestCommand()

Returns the test command string for this change request. This should be a string that can be used to launch a test to verify resolution of this request.

Returns:

the test command string for this change request.

See Also:

ChangeRequest.Type.TestCommandProperty.NAME

setTestCommand

public void setTestCommand(java.lang.String testCommand)

Sets the test command for this change request. This should be a string that can be used to launch a test to verify resolution of this request.

Parameters:

testCommand - the new test command for this change request.

getWorkAround

public java.lang.String getWorkAround()

Returns the workaround for this change request. This should be description of a possible way to avoid or render harmless the deficiency described by this request.

Returns:

the workaround for this change request.

See Also:

ChangeRequest.Type.WorkAroundProperty.NAME

setWorkAround

public void setWorkAround(java.lang.String workAround)

Sets the workaround for this change request. This should be description of a possible way to avoid or render harmless the deficiency described by this request.

Parameters:

workAround - the new workaround for this change request.

getFix

public java.lang.String getFix()

Returns the fix for this change request. This should be a description of the solution for the deficiency described by this request.

Returns:

the fix for this change request.

See Also:

ChangeRequest.Type.FixProperty.NAME

setFix

public void setFix(java.lang.String fix)

Sets the fix for this change request. This should be a description of the solution for the deficiency described by this request.

Parameters:

fix - the new fix for this change request.

getClosedOn

public DateTime getClosedOn()

Returns the date that this request was given a closed status.

Returns:

the date that this request was given a closed status.

See Also:

ChangeRequest.Type.ClosedOnProperty.NAME

getEnteredOn

public DateTime getEnteredOn()

Returns the date that this request was entered

Returns:

the date that this request was entered

See Also:

ChangeRequest.Type.EnteredByProperty.NAME

getVerifiedOn

public DateTime getVerifiedOn()

Returns the date that this Change Request was verified.

Returns:

The date that this Change Request was verified.

See Also:

ChangeRequest.Type.VerifiedOnProperty.NAME

getResolvedOn

public DateTime getResolvedOn()

Returns the date that this Change Request was resolved.

Returns:

The date that this Change Request was resolved.

See Also:

ChangeRequest.Type.ResolvedOnProperty.NAME

toString

public java.lang.String toString()

Returns the Number of this Change Request.

Overrides:

toString in class Item

Returns:

the Number of this Change Request.