com.starteam

Class Change.WebCacheChange

java.lang.Object

com.starteam.LiveObject.WebCacheLiveObject

com.starteam.Change.WebCacheChange

All Implemented Interfaces:

ArtifactCacheManager.Nameable, Change.ScmChangeAtom

Enclosing class:

Change

public static class Change.WebCacheChange
extends LiveObject.WebCacheLiveObject
implements Change.ScmChangeAtom

Change accessor for cached SDK Changes contained objects are obtained from the artifact cache

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAfterDisplayPath() Human-readable label for the right-hand file content's pathname
java.lang.String	getAfterDisplayRevision() Human-readable label for the right-hand file content's revision
java.lang.String	getAfterIdentifier() Unique identifier for retrieving the right-hand file content
Change.ChangeAtomType	getAtomType() the type of the Change Atom
java.lang.String	getBeforeDisplayPath() Human-readable label for the left-hand file content's pathname
java.lang.String	getBeforeDisplayRevision() Human-readable label for the left-hand file content's revision
java.lang.String	getBeforeIdentifier() Unique identifier for retrieving the left-hand file content
ChangePackage.WebCacheChangePackage	getChangePackage() Gets the ChangePackage that contains this Change object.
Change.ChangeType	getChangeType() Gets a value representing the type of change.
Change.CommitAction	getCommitAction() Gets a value representing the action that was performed to commit this change.
java.lang.String	getDescription() Gets a user-friendly description of this Change object.
Item.Type.WebCacheItemType	getItemType() Gets the type of the source and/or target item.
Item.WebCacheItem	getSourceItem() Gets the source endpoint of this change or NULL if the endpoint item is not cached in this ArtifactCache.
LinkValue.WebCacheLinkValue	getSourceLink() Gets this Change object's source, as a LinkValue.
DotNotation	getSourceVersion() Gets the version number of the source item.
Item.WebCacheItem	getTargetItem() Gets the target endpoint of this change or NULL if the target item is not cached in this ArtifactCache Note that getTargetLink() may return a non-null Link value, but getTargetItem() may still return null.
LinkValue.WebCacheLinkValue	getTargetLink() Gets this Change object's target, as a LinkValue.
DotNotation	getTargetVersion() Gets the version number of the target item.
Trace.WebCacheTrace[]	getTraces() Given a ViewMember in this artifact cache, resolve it to a set of locally cached Traces.
View.WebCacheView	getView() Gets the view that contains this Change object and the associated ChangePackage.
boolean	isDirectory() If there is no file content change to retrieve, this will be true.
boolean	isEnabled() Returns true if this change is enabled
void	setEnabled(boolean enabled) mark this change as enabled or disabled Disabled Changes will not report their attached links as resolveable members of the ChangePackage or associated Process Item.

Methods inherited from class com.starteam.LiveObject.WebCacheLiveObject

addTo, equals, getContext, getCreatedBy, getCreatedTime, getDisplayName, getID, getName, getNameProperty, 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

getChangePackage

public ChangePackage.WebCacheChangePackage getChangePackage()

Gets the ChangePackage that contains this Change object.

Returns:

ChangePackage

getTraces

public Trace.WebCacheTrace[] getTraces()

Given a ViewMember in this artifact cache, resolve it to a set of locally cached Traces. The returned Traces should only be manipulated via the ArtifactCache. Optimized to find the traces without issuing any server commands. The Change specified here must belong to this Artifact Cache

Returns:

a Trace[] of applicable Traces

getChangeType

public Change.ChangeType getChangeType()

Gets a value representing the type of change.

Returns:

ChangeType

getCommitAction

public Change.CommitAction getCommitAction()

Gets a value representing the action that was performed to commit this change.

Returns:

EnumeratedValue

getDescription

public java.lang.String getDescription()

Gets a user-friendly description of this Change object.

Returns:

String

getItemType

public Item.Type.WebCacheItemType getItemType()

Gets the type of the source and/or target item.

Returns:

Type

getSourceItem

public Item.WebCacheItem getSourceItem()

Gets the source endpoint of this change or NULL if the endpoint item is not cached in this ArtifactCache. Note that getSourceLink() may return a non-null Link value, but getSourceItem() may still return null.

Returns:

The source endpoint of this change.

getSourceLink

public LinkValue.WebCacheLinkValue getSourceLink()

Gets this Change object's source, as a LinkValue.

Returns:

LinkValue

getTargetItem

public Item.WebCacheItem getTargetItem()

Gets the target endpoint of this change or NULL if the target item is not cached in this ArtifactCache Note that getTargetLink() may return a non-null Link value, but getTargetItem() may still return null.

Returns:

The target endpoint of this change.

getTargetLink

public LinkValue.WebCacheLinkValue getTargetLink()

Gets this Change object's target, as a LinkValue.

Returns:

LinkValue

getView

public View.WebCacheView getView()

Gets the view that contains this Change object and the associated ChangePackage.

Returns:

View

getSourceVersion

public DotNotation getSourceVersion()

Gets the version number of the source item.

Returns:

The version number of the source item, or null.

getTargetVersion

public DotNotation getTargetVersion()

Gets the version number of the target item.

Returns:

The version number of the target item, or null.

isEnabled

public boolean isEnabled()

Returns true if this change is enabled

Returns:

true if this change is enabled

setEnabled

public void setEnabled(boolean enabled)

mark this change as enabled or disabled Disabled Changes will not report their attached links as resolveable members of the ChangePackage or associated Process Item. Administrative access rights are needed to disable changes

Parameters:

enabled - true to enable the change, false otherwise

getAfterDisplayPath

public java.lang.String getAfterDisplayPath()

Human-readable label for the right-hand file content's pathname

Specified by:

getAfterDisplayPath in interface Change.ScmChangeAtom

Returns:

Human-readable label for the right-hand file content's pathname

getAfterDisplayRevision

public java.lang.String getAfterDisplayRevision()

Human-readable label for the right-hand file content's revision

Specified by:

getAfterDisplayRevision in interface Change.ScmChangeAtom

Returns:

Human-readable label for the right-hand file content's revision

getAfterIdentifier

public java.lang.String getAfterIdentifier()

Unique identifier for retrieving the right-hand file content

Specified by:

getAfterIdentifier in interface Change.ScmChangeAtom

Returns:

Unique identifier for retrieving the right-hand file content

getBeforeDisplayPath

public java.lang.String getBeforeDisplayPath()

Human-readable label for the left-hand file content's pathname

Specified by:

getBeforeDisplayPath in interface Change.ScmChangeAtom

Returns:

Human-readable label for the left-hand file content's pathname

getBeforeDisplayRevision

public java.lang.String getBeforeDisplayRevision()

Human-readable label for the left-hand file content's revision

Specified by:

getBeforeDisplayRevision in interface Change.ScmChangeAtom

Returns:

Human-readable label for the left-hand file content's revision

getBeforeIdentifier

public java.lang.String getBeforeIdentifier()

Unique identifier for retrieving the left-hand file content

Specified by:

getBeforeIdentifier in interface Change.ScmChangeAtom

Returns:

Unique identifier for retrieving the left-hand file content

getAtomType

public Change.ChangeAtomType getAtomType()

the type of the Change Atom

Specified by:

getAtomType in interface Change.ScmChangeAtom

Returns:

the type of the change atom

isDirectory

public boolean isDirectory()

If there is no file content change to retrieve, this will be true.

Specified by:

isDirectory in interface Change.ScmChangeAtom

Returns:

true If there is no file content change to retrieve