com.starteam
Class VersionedObject.WebCacheVersionedObject

java.lang.Object
  extended by com.starteam.LiveObject.WebCacheLiveObject
      extended by com.starteam.TrackedObject.WebCacheTrackedObject
          extended by com.starteam.VersionedObject.WebCacheVersionedObject
Direct Known Subclasses:
ViewMember.WebCacheViewMember
Enclosing class:
VersionedObject

public static class VersionedObject.WebCacheVersionedObject
extends TrackedObject.WebCacheTrackedObject

Tracked Object accessor for cached SDK Objects contained objects are obtained from the artifact cache


Method Summary
 java.lang.String getComment()
          Gets the comment describing this revision of the item.
 DotNotation getDotNotation()
          Gets the dot notation identification of this resource version.
 int getRevisionNumber()
          Gets the revision number for this object revision.
 int getRootObjectID()
          Gets the root object ID for this resource.
 int getViewVersion()
          The version number of this item calculated by counting direct ancestors of this item from this version to the initial version.
 boolean isFromHistory()
          Determines whether or not this is a historical resource obtained from the history.
 
Methods inherited from class com.starteam.TrackedObject.WebCacheTrackedObject
getModifiedBy, getModifiedTime
 
Methods inherited from class com.starteam.LiveObject.WebCacheLiveObject
equals, getContext, getCreatedBy, getCreatedTime, getDisplayName, getID, getObjectID, getServer, getType, getValue, getValue, hashCode, isDirty, isNew, refresh, remove, setValue, setValue, toStarTeamURL, update
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getRevisionNumber

public int getRevisionNumber()
Gets the revision number for this object revision. The first revision has revision number zero.

Returns:
The revision number for this object revision.

getComment

public java.lang.String getComment()
Gets the comment describing this revision of the item.

Returns:
The comment describing this revision of the item.

getDotNotation

public DotNotation getDotNotation()
Gets the dot notation identification of this resource version.

The first version added to the repository will have a dot notation of "1.0". Each new revision will increment the version number portion so the second revision would be "1.1".

When an item branches a new branch number will be issued and revision will start counting from 0 again. For example, branching from version "1.2" might result in "1.2.5.0" after which the next version will be "1.2.5.1".

The value 5 in the previous example was assigned by the server based on the number of branches already made from the revision being branched.

Returns:
The dot notation identification of this resource version.

getRootObjectID

public int getRootObjectID()
Gets the root object ID for this resource. All resources with the same root object ID were derived from the same underlying object. Revisions with the same object ID are all on the same branch.

Returns:
The root object ID for this resource.

isFromHistory

public boolean isFromHistory()
Determines whether or not this is a historical resource obtained from the history.

Returns:
true if this is a historical resource obtained from the history.

getViewVersion

public int getViewVersion()
The version number of this item calculated by counting direct ancestors of this item from this version to the initial version. The first revision will have a view version number of (1).

Returns:
The view version number of this item.


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