com.starteam
Class Label.WebCacheLabel

java.lang.Object
  com.starteam.LiveObject.WebCacheLiveObject
      com.starteam.TrackedObject.WebCacheTrackedObject
          com.starteam.Label.WebCacheLabel

Enclosing class:

Label

public static class Label.WebCacheLabel
extends TrackedObject.WebCacheTrackedObject

View accessor for cached SDK views contained objects are obtained from the artifact cache

Method Summary

static Label.WebCacheLabel	create(ArtifactCacheManager.Context cntxt, View.WebCacheView parent, java.lang.String labelName, java.lang.String labelDescription, DateTime labelDateTime, boolean frozen) Creates a Label on the server.
java.lang.String	getDescription() Returns the label's description.
java.lang.String	getName() Return's the label's name.
DateTime	getRevisionTime() Returns the label's revision time.
boolean	isBuildLabel() Returns true if the label as being a StarTeam "Build" label.
boolean	isDeleted() Returns true if this label has been deleted.
boolean	isLocked() Return true if the label is locked or frozen.
boolean	isRevisionLabel() Returns true if the label is a revision label.
boolean	isViewLabel() Returns true if the label is a view label.
void	setDescription(java.lang.String description) Sets the label's description.
void	setName(java.lang.String name) Sets the label's name.

Methods inherited from class com.starteam.TrackedObject.WebCacheTrackedObject

getModifiedBy, getModifiedTime

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

create

public static Label.WebCacheLabel create(ArtifactCacheManager.Context cntxt,
                                         View.WebCacheView parent,
                                         java.lang.String labelName,
                                         java.lang.String labelDescription,
                                         DateTime labelDateTime,
                                         boolean frozen)

Creates a Label on the server. This label must be saved by assigning additional properties and then calling update() on the WebCacheLabel object Label creation is not transactable

Parameters:

cntxt - the ArtifactCacheManager User Session Context

parent - the parent view of this label.

labelName - the name of the new label

labelDescription - the description of the new label

labelDateTime - time the view configuration time (may not be null)

frozen - set true if the label is "frozen" (a frozen label can not be moved from one revision to another)

Returns:

the newly created Label.WebCacheLabel, wrapping a new Label

getName

public java.lang.String getName()

Return's the label's name. Label names must be unique within a view.

Returns:

the label's name.

isBuildLabel

public boolean isBuildLabel()

Returns true if the label as being a StarTeam "Build" label. Change Requests that have an "AddressedIn" field value of next build will have this label assigned to that field when the label is created.

Returns:

true if this "view label" is a build label.

getRevisionTime

public DateTime getRevisionTime()

Returns the label's revision time. This applies only to revision labels. The time specifies which revision of an item the label is attached to.

Returns:

the label's revision time.

isViewLabel

public boolean isViewLabel()

Returns true if the label is a view label. A view label applies to all items in the view.

Returns:

true if the label is a view label.

See Also:

Label.WebCacheLabel.isRevisionLabel()

isRevisionLabel

public boolean isRevisionLabel()

Returns true if the label is a revision label. By default a revision label applies to no items in a view whereas a view label, when created, applies to all items in the view.

Returns:

true is the label is a revision label.

isDeleted

public boolean isDeleted()

Returns true if this label has been deleted.

Returns:

true if this label has been deleted.

isLocked

public boolean isLocked()

Return true if the label is locked or frozen. The item revision to which a locked label applies can not be modified.

Returns:

true if the label is locked or frozen.

setName

public void setName(java.lang.String name)

Sets the label's name. Label names must be unique within a view.

Parameters:

name - the new label name

getDescription

public java.lang.String getDescription()

Returns the label's description.

Returns:

the label's description.

setDescription

public void setDescription(java.lang.String description)

Sets the label's description.

Parameters:

description - the new label description.