com.starbase.starteam
Class ItemReference

java.lang.Object
  |
  +--com.starbase.starteam.CacheRef
        |
        +--com.starbase.starteam.NamedCacheRef
              |
              +--com.starbase.starteam.TypedResource
                    |
                    +--com.starbase.starteam.SimpleTypedResource
                          |
                          +--com.starbase.starteam.ItemReference

All Implemented Interfaces:

java.lang.Cloneable

public class ItemReference

extends SimpleTypedResource

Method Summary

boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
ItemReference[]	getChildren() Returns an array of ItemReferences that are direct children of this ItemReferences, or an empty array if there are none.
OLEDate	getCreatedTime() Returns the CreatedTime for this item, only available on server versions 5.2 and higher.
int	getCreatedUserID() Returns the CreatedUserID of this item, only available on server versions 5.2 and higher.
OLEDate	getDeletedTime() Returns the DeletedTime of this item, only available on server versions 5.2 and higher.
int	getDeletedUserID() Returns the DeletedUserID of this item, only available on server versions 5.2 and higher.
int	getDerivedCount() Returns the number of shares directly derived from this item.
java.lang.String	getDotNotation() Returns the revision number in dot notation form.
OLEDate	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.
int	getItemID() Returns the Item's ItemID.
OLEDate	getModifiedTime() Returns the ModifiedTime of this item, only available on server versions 5.2 and higher.
int	getModifiedUserID() Returns the ModifiedUserID of this item, only available on server versions 5.2 and higher.
int	getObjectID() Returns the item's object ID.
ItemReference	getParent() Returns the parent of this ItemReference, or null if this is the root of the share tree.
int	getProjectID() Returns the Project ID of the project that contains this reference.
java.lang.String	getProjectName() Returns the containing Project's name.
int	getViewID() Returns the ViewID for this item.
java.lang.String	getViewPath() Returns the View path (in this format: "parent\child\grandchild...").
int	hashCode() returns a unique hash for all instances of this type
boolean	isDeleted() Returns true if the Item has been deleted.
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 a string containing one line for each property of the ItemReference.

Methods inherited from class com.starbase.starteam.SimpleTypedResource

get, getByteArray, getDouble, getEnumDisplayName, getID, getInt, getIntArray, getOLEDate, getPossibleValues, getPropertyNames, getString, getType, getTypeNames, put, putByPropertyID

Methods inherited from class com.starbase.starteam.TypedResource

addToIntArray, removeFromIntArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

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...").

getProjectID

public int getProjectID()

Returns the Project ID of the project that contains this reference.

Returns:

the Project ID of 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.

getChildren

public ItemReference[] getChildren()

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

Returns:

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

getParent

public ItemReference getParent()

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

Returns:

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

getObjectID

public int getObjectID()

Returns the item's object ID.

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 java.lang.String getDotNotation()

Returns the revision number in dot notation form.

Returns:

the revision number in dot notation form.

getItemID

public int getItemID()

Returns the Item's ItemID.

Returns:

the Item's ItemID.

getViewID

public int getViewID()

Returns the ViewID for this item.

Returns:

the ViewID for this item.

toString

public java.lang.String toString()

Returns a string containing one line for each property of the ItemReference.

Overrides:

toString in class TypedResource

Returns:

a string containing one line for each property of the ItemReference.

getCreatedTime

public OLEDate getCreatedTime()

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

Returns:

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

getCreatedUserID

public int getCreatedUserID()

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

Returns:

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

getModifiedTime

public OLEDate getModifiedTime()

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

Returns:

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

getEndModifiedTime

public OLEDate 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.

getModifiedUserID

public int getModifiedUserID()

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

Returns:

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

getDeletedTime

public OLEDate 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.

getDeletedUserID

public int getDeletedUserID()

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

Returns:

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

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class SimpleTypedResource

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class SimpleTypedResource

Returns:

int a unique hash for all instances of this type