com.starteam

Class Trace.WebCacheTrace

java.lang.Object

com.starteam.LiveObject.WebCacheLiveObject

com.starteam.TrackedObject.WebCacheTrackedObject

com.starteam.VersionedObject.WebCacheVersionedObject

com.starteam.ViewMember.WebCacheViewMember

com.starteam.Trace.WebCacheTrace

All Implemented Interfaces:

ArtifactCacheManager.Nameable, ArtifactCacheManager.Securable

Enclosing class:

Trace

public static class Trace.WebCacheTrace
extends ViewMember.WebCacheViewMember

Trace accessor for cached SDK Traces contained objects are obtained from the artifact cache

Method Summary

Modifier and Type	Method and Description
static Trace.WebCacheTrace	create(ArtifactCacheManager.Context cntxt, View.WebCacheView parent) Creates a Trace on the server.
java.lang.String	getDescription() Gets the description of this trace.
double	getOrder() Returns the order in which the trace should be executed.
ViewMember.WebCacheViewMember	getSource() Gets the source endpoint of this trace or NULL if the endpoint viewmember is not cached in this ArtifactCache
Change.WebCacheChange	getSourceChange() Gets the source endpoint of this trace or NULL *
LinkValue.WebCacheLinkValue	getSourceLink() Gets the source endpoint of this trace.
ViewMember.WebCacheViewMember	getSourceTip() Gets the tip revision of the source endpoint of this trace or NULL if the endpoint viewmember is not cached in this ArtifactCache
java.lang.String	getSourceVersions(Trace.Status statusValue) Returns the suspect transition versions of the source endpoint If a statusValue is not specified, the 'raw' value is returned.
Trace.Status	getStatus() Gets the Status of this Trace.
ViewMember.WebCacheViewMember	getTarget() Gets the target endpoint of this trace or NULL if the endpoint viewmember is not cached in this ArtifactCache
Change.WebCacheChange	getTargetChange() Gets the target endpoint of this trace or NULL *
LinkValue.WebCacheLinkValue	getTargetLink() Gets the target endpoint of this trace.
ViewMember.WebCacheViewMember	getTargetTip() Gets the tip revision of the target endpoint of this trace or NULL if the endpoint viewmember is not cached in this ArtifactCache
Trace.TraceType	getTraceType() Gets the TraceType of this Trace.
boolean	isSuspect() Determines whether the trace is suspect
void	pinSource() Set the source end-point of this trace to pinned.
void	pinTarget() Set the target end-point of this trace to pinned.
void	setDescription(java.lang.String description) Sets the description of this trace.
void	setOrder(double traceOrder) Sets the order in which the trace should be executed.
void	setSource(LinkValue.WebCacheLinkValue source) Sets the source endpoint of this trace.
void	setSource(LiveObject.WebCacheLiveObject source) Sets the source endpoint of this trace.
void	setSourceVersions(Trace.Status statusValue, java.lang.String version) Set a source version override for specific status value
void	setStatus(Trace.Status status) Set the status of the trace
void	setSuspect(boolean isSuspect) Mark the trace as suspect
void	setTarget(LinkValue.WebCacheLinkValue target) Sets the target endpoint of this trace.
void	setTarget(LiveObject.WebCacheLiveObject target) Sets the target endpoint of this trace.
void	setTraceType(Trace.TraceType type) Set the trace type of the trace
void	unpinSource() Set the source end-point of this trace to float.
void	unpinTarget() Set the target end-point of this trace to float.

Methods inherited from class com.starteam.ViewMember.WebCacheViewMember

getAttachments, getComment, getDeletedBy, getDeletedTime, getDisplayValue, getDotNotation, getExternalID, getExternalURL, getHistory, getLabels, getLinks, getLocker, getPresentationID, getRights, getShareTree, getTracedResources, getTraces, getView, getViewMemberRevisions, isBookmarked, isDeleted, isFloating, isPinned, isUnread, lock, lock, modifyBookmark, modifyReadStatus, pinTo, setAttachments, setComment, setExternalID, setExternalURL, setRights, toRESTUrl, unlock, unpin, updateRevisionComment

Methods inherited from class com.starteam.VersionedObject.WebCacheVersionedObject

getRevisionNumber, getRootObjectID, getShortComment, getViewVersion, isFromHistory, setShortComment

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

create

public static Trace.WebCacheTrace create(ArtifactCacheManager.Context cntxt,
                                         View.WebCacheView parent)

Creates a Trace on the server. This trace may be saved by assigning the various properties and then calling update() on the WebCacheTrace 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 view in which this new trace will be created. The parent view should be from the artifact cache

Returns:

the newly created Trace.WebCacheTrace, wrapping a new Trace

getSourceTip

public ViewMember.WebCacheViewMember getSourceTip()

Gets the tip revision of the source endpoint of this trace or NULL if the endpoint viewmember is not cached in this ArtifactCache

Returns:

The tip source endpoint of this trace.

getSource

public ViewMember.WebCacheViewMember getSource()

Gets the source endpoint of this trace or NULL if the endpoint viewmember is not cached in this ArtifactCache

Returns:

The source endpoint of this trace.

getSourceChange

public Change.WebCacheChange getSourceChange()

Gets the source endpoint of this trace or NULL *

getSourceLink

public LinkValue.WebCacheLinkValue getSourceLink()

Gets the source endpoint of this trace.

Returns:

The source endpoint of this trace.

setSource

public void setSource(LiveObject.WebCacheLiveObject source)

Sets the source endpoint of this trace.

Parameters:

source - The source liveobject of this trace. May be from this server or any other; the resulting source LinkValue will be an internal link or an external link as appropriate.

Throws:

java.lang.IllegalArgumentException - () if the source ViewMember is itself a Trace

setSource

public void setSource(LinkValue.WebCacheLinkValue source)

Sets the source endpoint of this trace.

Parameters:

source - The source linkvalue of this trace. May be from this server or any other; or may be a URL. the resulting source LinkValue will be an internal or external link as appropriate.

Throws:

java.lang.IllegalArgumentException - () if the source is null

getTargetTip

public ViewMember.WebCacheViewMember getTargetTip()

Gets the tip revision of the target endpoint of this trace or NULL if the endpoint viewmember is not cached in this ArtifactCache

Returns:

The tip target endpoint of this trace.

getTarget

public ViewMember.WebCacheViewMember getTarget()

Gets the target endpoint of this trace or NULL if the endpoint viewmember is not cached in this ArtifactCache

Returns:

The target endpoint of this trace.

getTargetChange

public Change.WebCacheChange getTargetChange()

Gets the target endpoint of this trace or NULL *

getTargetLink

public LinkValue.WebCacheLinkValue getTargetLink()

Gets the target endpoint of this trace.

Returns:

The target endpoint of this trace.

setTarget

public void setTarget(LiveObject.WebCacheLiveObject target)

Sets the target endpoint of this trace.

Parameters:

target - The target liveobject of this trace. May be from this server or any other; the resulting source LinkValue will be an internal link or an external link as appropriate.

Throws:

java.lang.IllegalArgumentException - () if the target ViewMember is itself a Trace

setTarget

public void setTarget(LinkValue.WebCacheLinkValue target)

Sets the target endpoint of this trace.

Parameters:

target - The target linkvalue of this trace. May be from this server or any other; or may be a URL. the resulting source LinkValue will be an internal or external link as appropriate.

Throws:

java.lang.IllegalArgumentException - () if the source is null

getDescription

public java.lang.String getDescription()

Gets the description of this trace.

Returns:

The description of this trace.

setDescription

public void setDescription(java.lang.String description)

Sets the description of this trace.

Parameters:

description - The description of this trace.

isSuspect

public boolean isSuspect()

Determines whether the trace is suspect

Returns:

true if the trace is suspect

setSuspect

public void setSuspect(boolean isSuspect)

Mark the trace as suspect

Parameters:

isSuspect - the suspect flag

getSourceVersions

public java.lang.String getSourceVersions(Trace.Status statusValue)

Returns the suspect transition versions of the source endpoint If a statusValue is not specified, the 'raw' value is returned. If a Status Value is specified, then the DotNotation of the matching status, if available, is returned

Parameters:

statusValue - a specific Trace Status to look for

Returns:

the suspect transition version(s) of the source endpoint

setSourceVersions

public void setSourceVersions(Trace.Status statusValue,
                              java.lang.String version)

Set a source version override for specific status value

Parameters:

statusValue - the status value to override

version - the new dot notation

getTraceType

public Trace.TraceType getTraceType()

Gets the TraceType of this Trace.

Returns:

Trace.TraceType

setTraceType

public void setTraceType(Trace.TraceType type)

Set the trace type of the trace

Parameters:

type - the trace type to set

getOrder

public double getOrder()

Returns the order in which the trace should be executed.

Returns:

the order in which the trace should be executed.

See Also:

Trace.Type.PropertyCollection.ORDER

setOrder

public void setOrder(double traceOrder)

Sets the order in which the trace should be executed.

Parameters:

traceOrder - the order in which the trace should be executed.

getStatus

public Trace.Status getStatus()

Gets the Status of this Trace.

Returns:

Status

setStatus

public void setStatus(Trace.Status status)

Set the status of the trace

Parameters:

status - the status to set

unpinSource

public void unpinSource()

Set the source end-point of this trace to float. i.e. the source will always match the tip ViewMember of the configuration

pinSource

public void pinSource()

Set the source end-point of this trace to pinned. i.e. the source will match the specified revision of the ViewMember

unpinTarget

public void unpinTarget()

Set the target end-point of this trace to float. i.e. the target will always match the tip ViewMember of the configuration

pinTarget

public void pinTarget()

Set the target end-point of this trace to pinned. i.e. the target will match the specified revision of the ViewMember