com.starteam
Class LiveObject.WebCacheLiveObject

java.lang.Object
  com.starteam.LiveObject.WebCacheLiveObject

Direct Known Subclasses:

Change.WebCacheChange, Project.WebCacheProject, TrackedObject.WebCacheTrackedObject, View.WebCacheView

Enclosing class:

LiveObject

public static class LiveObject.WebCacheLiveObject
extends java.lang.Object

Base accessor for cached SDK objects encapsulating the statefulness of objects obtained from the artifact cache.

Method Summary

void	addTo(ObjectArrayProperty.WebCacheObjectArrayProperty property, LiveObject.WebCacheLiveObject object) Add the live object specified to the array of object values
boolean	equals(java.lang.Object o) Test this object for equality wiith another
ArtifactCacheManager.Context	getContext() Returns the context of this object.
User.WebCacheUser	getCreatedBy() Get the user who created this object.
DateTime	getCreatedTime() Gets the date and time at which this object was created.
java.lang.String	getDisplayName() Gets a short string that can be used to refer to this item in an application's user interface.
int	getID() Returns the ID of its underlying object.
int	getObjectID() Gets the unique identifier for the underlying object.
Server.WebCacheServer	getServer() return the Server for this cached object
Type.WebCacheType	getType() Returns the type of this resource.
java.lang.Object	getValue(Property.WebCacheProperty p) Returns the value of the property
java.lang.Object	getValue(java.lang.String propertyName) get the value of the property as specified by name
int	hashCode() Return a hash code for this object
boolean	hasValue(ObjectArrayProperty.WebCacheObjectArrayProperty property, LiveObject.WebCacheLiveObject object) Return true if the live object argument is a member of the object array for the specified object array property
boolean	isDirty() Return true if this object is dirty
boolean	isNew() Returns true if this resource has not yet been stored in the server.
void	refresh() replace the (possibly out-dated) instance of the contained live object with an appropriate read only instance from the ArtifactCache
void	remove() Remove this LiveObject from the repository This is an atomic operation, not executed in a transaction
void	removeFrom(ObjectArrayProperty.WebCacheObjectArrayProperty property, LiveObject.WebCacheLiveObject object) Remove the live object specified from the array of object values
void	setValue(Property.WebCacheProperty p, java.lang.Object value) Sets the value of the property
void	setValue(java.lang.String propertyName, java.lang.Object value) set the value of the property as specified by name
java.lang.String	toStarTeamURL() Resolves this StarTeam resource to a corresponding URL using an ID based scheme
void	update() Save this LiveObject to the Repository If the underlying SDK object is new, create it Otherwise, if it has changed, update it This is an atomic operation, not executed in a transaction

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getServer

public Server.WebCacheServer getServer()

return the Server for this cached object

Returns:

the Server for this cached object

getContext

public ArtifactCacheManager.Context getContext()

Returns the context of this object.

Returns:

the context of this object.

isNew

public boolean isNew()

Returns true if this resource has not yet been stored in the server.

Returns:

true if this resource has not yet been stored in the server.

getObjectID

public int getObjectID()

Gets the unique identifier for the underlying object.

Returns:

The unique identifier for the underlying object.

getID

public int getID()

Returns the ID of its underlying object.

Returns:

the ID of the underlying object

refresh

public void refresh()

replace the (possibly out-dated) instance of the contained live object with an appropriate read only instance from the ArtifactCache

setValue

public void setValue(java.lang.String propertyName,
                     java.lang.Object value)

set the value of the property as specified by name

Parameters:

propertyName - the name of the property

value - the value to set

getValue

public java.lang.Object getValue(java.lang.String propertyName)

get the value of the property as specified by name

Parameters:

propertyName - the name of the property

Returns:

the value of the property

hasValue

public boolean hasValue(ObjectArrayProperty.WebCacheObjectArrayProperty property,
                        LiveObject.WebCacheLiveObject object)

Return true if the live object argument is a member of the object array for the specified object array property

Parameters:

property - the object array property

object - the candidate member to look for

Returns:

true of the candidate is a member of the array

addTo

public void addTo(ObjectArrayProperty.WebCacheObjectArrayProperty property,
                  LiveObject.WebCacheLiveObject object)

Add the live object specified to the array of object values

Parameters:

property - the object array property

object - the live object to add

removeFrom

public void removeFrom(ObjectArrayProperty.WebCacheObjectArrayProperty property,
                       LiveObject.WebCacheLiveObject object)

Remove the live object specified from the array of object values

Parameters:

property - the object array property

object - the live object to remove

getValue

public java.lang.Object getValue(Property.WebCacheProperty p)

Returns the value of the property

Parameters:

p - get the value of the property

Returns:

the value of the property

setValue

public void setValue(Property.WebCacheProperty p,
                     java.lang.Object value)

Sets the value of the property

Parameters:

p - the property

value - its new value

getDisplayName

public java.lang.String getDisplayName()

Gets a short string that can be used to refer to this item in an application's user interface.

Returns:

A short string that can be used to refer to this item in an application's user interface.

isDirty

public boolean isDirty()

Return true if this object is dirty

Returns:

true if this object is dirty

update

public void update()

Save this LiveObject to the Repository If the underlying SDK object is new, create it Otherwise, if it has changed, update it This is an atomic operation, not executed in a transaction

See Also:

for transacted operations

getType

public Type.WebCacheType getType()

Returns the type of this resource.

Returns:

the type of this resource.

remove

public void remove()

Remove this LiveObject from the repository This is an atomic operation, not executed in a transaction

See Also:

for transacted operations

equals

public boolean equals(java.lang.Object o)

Test this object for equality wiith another

Overrides:

equals in class java.lang.Object

Parameters:

o - the object to test against

hashCode

public int hashCode()

Return a hash code for this object

Overrides:

hashCode in class java.lang.Object

Returns:

a hashcode for this object

getCreatedTime

public DateTime getCreatedTime()

Gets the date and time at which this object was created.

Returns:

The date and time at which this object was created.

getCreatedBy

public User.WebCacheUser getCreatedBy()

Get the user who created this object.

Returns:

The user who created this object.

toStarTeamURL

public java.lang.String toStarTeamURL()

Resolves this StarTeam resource to a corresponding URL using an ID based scheme

Returns:

a String URL that uniquely identifies this resource