com.starteam
Class Change.WebCacheChange

java.lang.Object
  extended by com.starteam.LiveObject.WebCacheLiveObject
      extended by com.starteam.Change.WebCacheChange
Enclosing class:
Change

public static class Change.WebCacheChange
extends LiveObject.WebCacheLiveObject

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


Method Summary
 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.
 LinkValue.WebCacheLinkValue getSourceLink()
          Gets this Change object's source, as a LinkValue.
 DotNotation getSourceVersion()
          Gets the version number of the source item.
 LinkValue.WebCacheLinkValue getTargetLink()
          Gets this Change object's target, as a LinkValue.
 DotNotation getTargetVersion()
          Gets the version number of the target item.
 View.WebCacheView getView()
          Gets the view that contains this Change object and the associated ChangePackage.
 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, 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

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

getSourceLink

public LinkValue.WebCacheLinkValue getSourceLink()
Gets this Change object's source, as a LinkValue.

Returns:
LinkValue

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


StarTeam SDK 14.0, Build 21
Copyright © 2003-2012 Borland Software Corporation. All rights reserved.