com.starteam

Class Share

java.lang.Object

com.starteam.TypedResource

com.starteam.LiveObject

com.starteam.TrackedObject

com.starteam.Share

All Implemented Interfaces:

java.lang.Cloneable

public final class Share
extends TrackedObject

This class represents the share tree of an item

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Share.Type Type for share
static class	Share.WebCacheShare Base accessor for cached SDK Shares

Nested classes/interfaces inherited from class com.starteam.TrackedObject

TrackedObject.WebCacheTrackedObject

Nested classes/interfaces inherited from class com.starteam.LiveObject

LiveObject.WebCacheLiveObject

Nested classes/interfaces inherited from class com.starteam.TypedResource

TypedResource.BranchState

Method Summary

Modifier and Type	Method and Description
Label[]	getAttachedLabels(ViewMember.Type typ) Return the labels attached to this share, if any
Share[]	getChildShares() Returns an array of Shares that are direct children of this Share, or an empty array if there are none.
User	getCreatedBy() Returns the User who created this item, only available on server versions 5.2 and higher.
DateTime	getCreatedTime() Returns the CreatedTime for this item, only available on server versions 5.2 and higher.
User	getDeletedBy() Returns the User who deleted this item, only available on server versions 5.2 and higher.
DateTime	getDeletedTime() Returns the DeletedTime of this item, only available on server versions 5.2 and higher.
int	getDerivedCount() Returns the number of shares directly derived from this item.
DotNotation	getDotNotation() Returns the revision number in dot notation form.
DateTime	getEndModifiedTime() Returns the EndModifiedTime of this item, only available on server versions 5.2 and higher.
int	getFolderItemID() Returns the Item ID of the referenced Item's parent Folder.
java.lang.String	getFolderPath() Returns the folder path of the referenced Item's parent Folder.
ViewMemberCollection	getHistory(ViewMember.Type typ)
int	getID() throws UnsupportedOperationException()
User	getModifiedBy() Returns the User who last modified this item, only available on server versions 5.2 and higher.
DateTime	getModifiedTime() Returns the ModifiedTime of this item, only available on server versions 5.2 and higher.
int	getObjectID() Returns the item's object ID.
Share	getParentShare() Returns the parent of this Share, or null if this is the root of the share tree.
Project	getProject() Returns the project that contains this reference.
java.lang.String	getProjectName() Returns the containing Project's name.
Share.Type.PropertyCollection	getProperties() Get all the properties of the share
View	getView() Returns the View for this share.
java.lang.String	getViewPath() Returns the View path (in this format: "parent\child\grandchild...").
int	getVMID() Returns the shared ViewMember's VMID.
boolean	isDeleted() Returns true if the Item has been deleted.
boolean	isFirstOfItsBranch() Determines whether or not this share is the first share of its branch.
boolean	isRelated() Returns true if this item contains the revision queried by Item.getReferences() in its history.
boolean	isViewDeleted() Returns true if the item's View has been deleted.
java.lang.String	toString() Returns the ID of this Share.

Methods inherited from class com.starteam.LiveObject

toStarTeamURL

Methods inherited from class com.starteam.TypedResource

addToIntegerArray, getBooleanValue, getByteArrayValue, getCachedProperties, getContentValue, getDateTimeValue, getDateValue, getDisplayName, getDoubleValue, getEnumDisplayName, getEnumeratedValues, getIntegerArrayValue, getIntegerValue, getLinkValue, getLongValue, getPossibleValues, getServer, getStringValue, getTimeSpanValue, getType, getValue, hasCachedProperties, hasValue, isDirty, isDirty, isNew, removeFromIntegerArray, setBooleanValue, setByteArrayValue, setContentValue, setDateTimeValue, setDateValue, setDoubleValue, setEnumeratedValue, setEnumeratedValues, setIntegerArrayValue, setIntegerValue, setLinkValue, setLongValue, setStringValue, setTimeSpanValue, setValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getProperties

public Share.Type.PropertyCollection getProperties()

Get all the properties of the share

Returns:

Collection of Share properties

getID

public int getID()

throws UnsupportedOperationException()

Overrides:

getID in class TypedResource

Returns:

The unique identifier for this resource.

getFolderItemID

public int getFolderItemID()

Returns the Item ID of the referenced Item's parent Folder.

Returns:

the Item ID of the referenced Item's parent Folder.

getFolderPath

public java.lang.String getFolderPath()

Returns the folder path of the referenced Item's parent Folder.

Returns:

the folder path of the referenced Item's parent Folder.

isViewDeleted

public boolean isViewDeleted()

Returns true if the item's View has been deleted.

Returns:

true if the item's View has been deleted.

isDeleted

public boolean isDeleted()

Returns true if the Item has been deleted.

Returns:

true if the Item has been deleted.

isRelated

public boolean isRelated()

Returns true if this item contains the revision queried by Item.getReferences() in its history.

Returns:

true if this item contains the revision queried by Item.getReferences() in its history.

getViewPath

public java.lang.String getViewPath()

Returns the View path (in this format: "parent\child\grandchild...").

Returns:

the View path (in this format: "parent\child\grandchild...").

getProject

public Project getProject()

Returns the project that contains this reference.

Returns:

the project that contains this reference.

getDerivedCount

public int getDerivedCount()

Returns the number of shares directly derived from this item.

Returns:

the number of shares directly derived from this item.

getObjectID

public int getObjectID()

Returns the item's object ID.

Overrides:

getObjectID in class TypedResource

Returns:

the item's object ID.

getProjectName

public java.lang.String getProjectName()

Returns the containing Project's name.

Returns:

the containing Project's name.

getDotNotation

public DotNotation getDotNotation()

Returns the revision number in dot notation form.

Returns:

the revision number in dot notation form.

getVMID

public int getVMID()

Returns the shared ViewMember's VMID.

Returns:

the shared ViewMember's VMID.

getView

public View getView()

Returns the View for this share. Will return NULL if the View has been deleted

Returns:

the View for this share, or NULL if the View has been deleted

toString

public java.lang.String toString()

Returns the ID of this Share.

Overrides:

toString in class TypedResource

Returns:

the ID of this Share.

getCreatedTime

public DateTime getCreatedTime()

Returns the CreatedTime for this item, only available on server versions 5.2 and higher.

Overrides:

getCreatedTime in class LiveObject

Returns:

the CreatedTime for this item, only available on server versions 5.2 and higher.

getCreatedBy

public User getCreatedBy()

Returns the User who created this item, only available on server versions 5.2 and higher.

Overrides:

getCreatedBy in class LiveObject

Returns:

the User who created this item, only available on server versions 5.2 and higher.

getModifiedTime

public DateTime getModifiedTime()

Returns the ModifiedTime of this item, only available on server versions 5.2 and higher.

Overrides:

getModifiedTime in class TrackedObject

Returns:

the ModifiedTime of this item, only available on server versions 5.2 and higher.

getEndModifiedTime

public DateTime getEndModifiedTime()

Returns the EndModifiedTime of this item, only available on server versions 5.2 and higher.

Returns:

the EndModifiedTime of this item, only available on server versions 5.2 and higher.

getModifiedBy

public User getModifiedBy()

Returns the User who last modified this item, only available on server versions 5.2 and higher.

Overrides:

getModifiedBy in class TrackedObject

Returns:

the User who last modified this item, only available on server versions 5.2 and higher.

getDeletedTime

public DateTime getDeletedTime()

Returns the DeletedTime of this item, only available on server versions 5.2 and higher.

Returns:

the DeletedTime of this item, only available on server versions 5.2 and higher.

getDeletedBy

public User getDeletedBy()

Returns the User who deleted this item, only available on server versions 5.2 and higher.

Returns:

the User who deleted this item, only available on server versions 5.2 and higher.

getParentShare

public Share getParentShare()

Returns the parent of this Share, or null if this is the root of the share tree.

Returns:

the parent of this Share, or null if this is the root of the share tree.

getChildShares

public Share[] getChildShares()

Returns an array of Shares that are direct children of this Share, or an empty array if there are none.

Returns:

an array of Shares that are direct children of this Share, or an empty array if there are none.

isFirstOfItsBranch

public boolean isFirstOfItsBranch()

Determines whether or not this share is the first share of its branch.

Returns:

true if this share is the first share of its branch; false if its parent share (or an ancestor share) is on the same branch.

getAttachedLabels

public Label[] getAttachedLabels(ViewMember.Type typ)

Return the labels attached to this share, if any

Parameters:

typ - the type of the item referenced by the share

Returns:

the labels attached to this share

getHistory

public ViewMemberCollection getHistory(ViewMember.Type typ)