com.starbase.starteam
Class ChangeRequest

java.lang.Object
  |
  +--com.starbase.starteam.CacheRef
        |
        +--com.starbase.starteam.NamedCacheRef
              |
              +--com.starbase.starteam.TypedResource
                    |
                    +--com.starbase.starteam.SimpleTypedResource
                          |
                          +--com.starbase.starteam.Item
                                |
                                +--com.starbase.starteam.ChangeRequest

All Implemented Interfaces:

java.lang.Cloneable, ISecurable, ISecurableObject

public class ChangeRequest

extends Item

Represents a StarTeam ChangeRequest item.

Nested Class Summary

Nested classes inherited from class com.starbase.starteam.Item

Item.LockType

Constructor Summary

ChangeRequest(Folder parentFolder)
Constructs a new ChangeRequest in the specified folder.

Method Summary

boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
int	getAddressedBy() Returns the user ID for the user that addressed this request.
int	getAddressedIn() Returns a label ID representing the build or named configuration that this request was addressed in.
int	getAddressedInView() Returns the ID of the view from which this Change Request was addressed.
java.lang.String	getCategory() Returns the category of this request.
OLEDate	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.
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.
int	getLastBuildTested() Returns a label ID 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.
int	getPlatform() Returns the platform this Change Request applies to.
java.lang.String	getPlatformDisplayName(int value) Returns a user-friendly display name for the given Platform value.
int[]	getPossiblePlatform() Returns the possible enum codes that are valid transition values for the Platform property.
int[]	getPossiblePriority() Returns the possible enum codes that are valid transition values for the Priority property.
int[]	getPossibleRequestType() Returns the possible enum codes that are valid transition values for the RequestType property.
int[]	getPossibleSeverity() Returns the possible enum codes that are valid transition values for the Severity property.
int[]	getPossibleStatus() Returns the possible enum codes that are valid transition values for the Status property.
int	getPriority() Returns the relative priority of this Change Request.
java.lang.String	getPriorityDisplayName(int value) Returns a user-friendly display name for the given Priority value.
int	getReadStatus() A flag indicating whether or not the user has read this item before.
int	getRequestType() Returns this change request's type.
java.lang.String	getRequestTypeDisplayName(int value) Returns a user-friendly display name for the given RequestType value.
OLEDate	getResolvedOn() Returns the date that this Change Request was resolved.
int	getResponsibility() Returns the user ID that is currently responsible for this request.
int	getSeverity() Return the relative severity of the condition that this Change Request represents.
java.lang.String	getSeverityDisplayName(int value) Returns a user-friendly display name for the given Severity value.
int	getStatus() Returns the status (Open, Fixed, Closed, etc.) of this Change Request.
java.lang.String	getStatusDisplayName(int value) Returns a user-friendly display name for the given Status value.
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.
OLEDate	getVerifiedOn() Returns the date that this Change Request was verified.
java.lang.String	getWorkAround() Returns the workaround for this change request.
int	hashCode() returns a unique hash for all instances of this type
void	setAddressedBy(int userID) Sets the user ID for the user that addressed this request.
void	setAddressedIn(int labelID) Sets the label ID in which this change request was addressed.
void	setAddressedInView(int viewID) Sets the ID of 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	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(int labelID) Sets the label ID for the build in which the change request was last tested.
void	setPlatform(int platform) Sets the platform this change request applies to.
void	setPriority(int priority) Sets the priority of this change request.
void	setRequestType(int type) Sets this change request's type.
void	setResponsibility(int userID) Sets the responsibility of this change request to the specified user ID.
void	setSeverity(int severity) Sets the severity for this change request.
void	setStatus(int status) Sets the status of this 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 a string representation of this change request.
void	update() Persists the properties of this request to the repository.

Methods inherited from class com.starbase.starteam.Item

acquireOwnership, addAttachment, copy, createAttachment, createAttachmentFromFile, createItem, deleteMergePoint, discard, get, getACL, getAllLabels, getAttachedLabels, getAttachment, getAttachmentIDs, getAttachmentNames, getAttachmentToFile, getBehavior, getBranchRevisionFromDotNotation, getByProperty, getByPropertyID, getByteArray, getCachedProperties, getComment, getCommonAncestor, getCreatedBy, getCreatedTime, getDeletedTime, getDeletedUserID, getDisplayValue, getDotNotation, getDouble, getEnumDisplayName, getFlag, getFlagDisplayName, getFromHistoryByDate, getFromHistoryByLabelID, getFromHistoryByVersion, getHistory, getID, getInt, getIntArray, getItemID, getItemRevisions, getLocker, getMergeHistory, getModifiedBy, getModifiedTime, getMyLock, getNewRevisionComment, getObjectID, getOLEDate, getOwner, getParentContainer, getParentFolder, getParentFolderHierarchy, getParentFolderName, getParentFolderPath, getParentFolderQualifiedName, getParentRevision, getPossibleFlag, getPossibleReadStatus, getPossibleValues, getPropertyNames, getReadStatusDisplayName, getReference, getReferences, getRevisionNumber, getRootObjectID, getServer, getString, getType, getTypeNames, getView, getViewVersion, getViewVersionFromDotNotation, hasPermission, hasValues, isBranchable, isDeleted, isDirty, isDisembodied, isEqualTo, isFromHistory, isNew, isRefreshRequired, isRefreshRequired, isReverseShareRecommended, isRootShare, lock, modifyFlagForUser, modifyReadStatusForUser, move, moveTo, populate, populate, put, putByPropertyID, putLock, recordMergePoint, refresh, refresh, remove, removeAttachment, resolveMergePoint, reverseShareTo, setACL, setBehavior, setBranchOnChange, setComment, setFixedConfig, setFloatingConfig, shareTo, smartShareTo, toDebugString, unlock, updateRevisionComment

Methods inherited from class com.starbase.starteam.TypedResource

addToIntArray, removeFromIntArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChangeRequest

public ChangeRequest(Folder parentFolder)

Constructs a new ChangeRequest in the specified folder.

Parameters:

parentFolder - the folder in which this change request will be stored.

Method Detail

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:

PropertyNames.CR_EXTERNAL_REFERENCE

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:

PropertyNames.CR_CHANGE_NUMBER

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:

PropertyNames.CR_SYNOPSIS

setSynopsis

public void setSynopsis(java.lang.String synopsis)

Sets the synopsis for this change request.

Parameters:

synopsis - the new synopsis for this change request

getRequestType

public int 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.getPossibleRequestType(), ChangeRequest.getRequestTypeDisplayName(int), PropertyNames.CR_TYPE

setRequestType

public void setRequestType(int type)

Sets this change request's type.

Parameters:

type - The new type for this change request.

getPossibleRequestType

public int[] getPossibleRequestType()

Returns the possible enum codes that are valid transition values for the RequestType property. This is really a convenience method for accessing Property.getEnumValues for this property.

Returns:

The possible values for the RequestType property.

See Also:

ChangeRequest.getRequestType(), ChangeRequest.getRequestTypeDisplayName(int), TypedResource.getPossibleValues(java.lang.String), PropertyNames.CR_TYPE

getRequestTypeDisplayName

public java.lang.String getRequestTypeDisplayName(int value)

Returns a user-friendly display name for the given RequestType value. This is really a convenience method for accessing TypedResource.getEnumDisplayName for this property.

Parameters:

value - The RequestType value to be converted to a display name.

Returns:

A user-friendly display name for the given RequestType value.

See Also:

ChangeRequest.getRequestType(), ChangeRequest.getPossibleRequestType(), TypedResource.getEnumDisplayName(java.lang.String, int), PropertyNames.CR_TYPE

getStatus

public int 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.getPossibleStatus(), ChangeRequest.getStatusDisplayName(int), PropertyNames.CR_STATUS

setStatus

public void setStatus(int status)

Sets the status of this change request.

Parameters:

status - The new status value for this change request.

getPossibleStatus

public int[] getPossibleStatus()

Returns the possible enum codes that are valid transition values for the Status property. This is really a convenience method for accessing Property.getEnumValues for this property.

Returns:

The possible enum values for the Status property.

See Also:

ChangeRequest.getStatus(), ChangeRequest.getStatusDisplayName(int), TypedResource.getPossibleValues(java.lang.String), PropertyNames.CR_STATUS

getStatusDisplayName

public java.lang.String getStatusDisplayName(int value)

Returns a user-friendly display name for the given Status value. This is really a convenience method for accessing TypedResource.getEnumDisplayName for this property.

Parameters:

value - The Status value to be converted to a display name.

Returns:

A user-friendly display name for the given Status value.

See Also:

ChangeRequest.getStatus(), ChangeRequest.getPossibleStatus(), TypedResource.getEnumDisplayName(java.lang.String, int), PropertyNames.CR_STATUS

getSeverity

public int 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.getPossibleSeverity(), ChangeRequest.getSeverityDisplayName(int), PropertyNames.CR_SEVERITY

setSeverity

public void setSeverity(int severity)

Sets the severity for this change request.

Parameters:

severity - The new severity value for this change request.

getPossibleSeverity

public int[] getPossibleSeverity()

Returns the possible enum codes that are valid transition values for the Severity property. This is really a convenience method for accessing Property.getEnumValues for this property.

Returns:

The possible enum value for the severity property

See Also:

ChangeRequest.getSeverity(), ChangeRequest.getSeverityDisplayName(int), TypedResource.getPossibleValues(java.lang.String), PropertyNames.CR_SEVERITY

getSeverityDisplayName

public java.lang.String getSeverityDisplayName(int value)

Returns a user-friendly display name for the given Severity value. This is really a convenience method for accessing TypedResource.getEnumDisplayName for this property.

Parameters:

value - The Severity value to be converted to a display name.

Returns:

A user-friendly display name for the given Severity value.

See Also:

ChangeRequest.getSeverity(), ChangeRequest.getPossibleSeverity(), TypedResource.getEnumDisplayName(java.lang.String, int), PropertyNames.CR_SEVERITY

getAddressedIn

public int getAddressedIn()

Returns a label ID 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 ID for the build in which this request was addressed

See Also:

PropertyNames.CR_ADDRESSED_IN

setAddressedIn

public void setAddressedIn(int labelID)

Sets the label ID 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_ID

Parameters:

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

See Also:

Label.NEXT_BUILD_ID

getAddressedBy

public int getAddressedBy()

Returns the user ID for the user that addressed this request.

Returns:

the user ID for the user that addressed this request.

See Also:

PropertyNames.CR_ADDRESSED_BY

setAddressedBy

public void setAddressedBy(int userID)

Sets the user ID for the user that addressed this request.

Parameters:

userID - the user ID for the user that addressed this request.

getAddressedInView

public int getAddressedInView()

Returns the ID of the view from which this Change Request was addressed.

Returns:

The ID of the view from which this Change Request was addressed.

See Also:

PropertyNames.CR_ADDRESSED_IN_VIEW

setAddressedInView

public void setAddressedInView(int viewID)

Sets the ID of the view from which this Change Request was addressed.

Parameters:

viewID - The new view ID.

getLastBuildTested

public int getLastBuildTested()

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

Returns:

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

See Also:

PropertyNames.CR_LAST_BUILD_TESTED

setLastBuildTested

public void setLastBuildTested(int labelID)

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

Parameters:

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

getResponsibility

public int getResponsibility()

Returns the user ID that is currently responsible for this request.

Returns:

the user ID that is currently responsible for this request.

See Also:

PropertyNames.CR_RESPONSIBILITY

setResponsibility

public void setResponsibility(int userID)

Sets the responsibility of this change request to the specified user ID.

Parameters:

userID - the user ID of the user responsible for this request

getPriority

public int getPriority()

Returns the relative priority of this Change Request.

Returns:

The relative priority of this Change Request.

See Also:

ChangeRequest.getPossiblePriority(), ChangeRequest.getPriorityDisplayName(int), PropertyNames.CR_PRIORITY

setPriority

public void setPriority(int priority)

Sets the priority of this change request.

Parameters:

priority - The new priority for this change request.

getPossiblePriority

public int[] getPossiblePriority()

Returns the possible enum codes that are valid transition values for the Priority property. This is really a convenience method for accessing Property.getEnumValues for this property.

Returns:

The possible enum values for the priority property.

See Also:

ChangeRequest.getPriority(), ChangeRequest.getPriorityDisplayName(int), TypedResource.getPossibleValues(java.lang.String), PropertyNames.CR_PRIORITY

getPriorityDisplayName

public java.lang.String getPriorityDisplayName(int value)

Returns a user-friendly display name for the given Priority value. This is really a convenience method for accessing TypedResource.getEnumDisplayName for this property.

Parameters:

value - The Priority value to be converted to a display name.

Returns:

A user-friendly display name for the given Priority value.

See Also:

ChangeRequest.getPriority(), ChangeRequest.getPossiblePriority(), TypedResource.getEnumDisplayName(java.lang.String, int), PropertyNames.CR_PRIORITY

getDescription

public java.lang.String getDescription()

Returns the description of this change request.

Returns:

the description of this change request.

See Also:

PropertyNames.CR_DESCRIPTION

setDescription

public void setDescription(java.lang.String description)

Sets the description of this change request.

Parameters:

description - the new description for this change request.

getPlatform

public int getPlatform()

Returns the platform this Change Request applies to.

Returns:

The platform this Change Request applies to.

See Also:

ChangeRequest.getPossiblePlatform(), ChangeRequest.getPlatformDisplayName(int), PropertyNames.CR_PLATFORM

setPlatform

public void setPlatform(int platform)

Sets the platform this change request applies to.

Parameters:

platform - The new platform this change request applies to.

getPossiblePlatform

public int[] getPossiblePlatform()

Returns the possible enum codes that are valid transition values for the Platform property. This is really a convenience method for accessing Property.getEnumValues for this property.

Returns:

the possible enum values for the platform property.

See Also:

ChangeRequest.getPlatform(), ChangeRequest.getPlatformDisplayName(int), TypedResource.getPossibleValues(java.lang.String), PropertyNames.CR_PLATFORM

getPlatformDisplayName

public java.lang.String getPlatformDisplayName(int value)

Returns a user-friendly display name for the given Platform value. This is really a convenience method for accessing TypedResource.getEnumDisplayName for this property.

Parameters:

value - The Platform value to be converted to a display name.

Returns:

A user-friendly display name for the given Platform value.

See Also:

ChangeRequest.getPlatform(), ChangeRequest.getPossiblePlatform(), TypedResource.getEnumDisplayName(java.lang.String, int), PropertyNames.CR_PLATFORM

getCategory

public java.lang.String getCategory()

Returns the category of this request.

Returns:

the category of this request.

See Also:

PropertyNames.CR_CATEGORY

setCategory

public void setCategory(java.lang.String category)

Sets the category for this change request.

Parameters:

category - the new category for this change request

getComponent

public java.lang.String getComponent()

Returns the component this request applies to.

Returns:

the component this request applies to.

See Also:

PropertyNames.CR_COMPONENT

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

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:

PropertyNames.CR_TEST_COMMAND

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:

PropertyNames.CR_WORK_AROUND

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:

PropertyNames.CR_FIX

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 OLEDate 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:

PropertyNames.CR_CLOSED_ON

getVerifiedOn

public OLEDate getVerifiedOn()

Returns the date that this Change Request was verified.

Returns:

The date that this Change Request was verified.

See Also:

PropertyNames.CR_VERIFIED_ON

getResolvedOn

public OLEDate getResolvedOn()

Returns the date that this Change Request was resolved.

Returns:

The date that this Change Request was resolved.

See Also:

PropertyNames.CR_RESOLVED_ON

getReadStatus

public int getReadStatus()

A flag indicating whether or not the user has read this item before.

Overrides:

getReadStatus in class Item

Returns:

A flag indicating whether or not the user has read this item before.

See Also:

Item.getReadStatus()

update

public void update()

Persists the properties of this request to the repository.

Overrides:

update in class Item

toString

public java.lang.String toString()

Returns a string representation of this change request.

Overrides:

toString in class Item

Returns:

a string representation of this change request.

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class Item

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class Item

Returns:

int a unique hash for all instances of this type