com.starteam

Class WhiteBoard.WebCacheWhiteBoard

java.lang.Object

com.starteam.LiveObject.WebCacheLiveObject

com.starteam.TrackedObject.WebCacheTrackedObject

com.starteam.VersionedObject.WebCacheVersionedObject

com.starteam.ViewMember.WebCacheViewMember

com.starteam.Item.WebCacheItem

com.starteam.WhiteBoard.WebCacheWhiteBoard

All Implemented Interfaces:

ArtifactCacheManager.Identifiable, ArtifactCacheManager.Nameable, ArtifactCacheManager.Securable

Enclosing class:

WhiteBoard

public static class WhiteBoard.WebCacheWhiteBoard
extends Item.WebCacheItem

Item accessor for cached SDK WhiteBoard items contained objects are obtained from the artifact cache

Method Summary

Modifier and Type	Method and Description
static WhiteBoard.WebCacheWhiteBoard	create(ArtifactCacheManager.Context cntxt, Folder.WebCacheFolder parent) Creates a WhiteBoard on the server.
java.lang.String	getColor() Returns the color of this WhiteBoard.
java.lang.String	getDescription() Returns the description of this WhiteBoard.
IntegerProperty.WebCacheIntegerProperty	getIdentifierProperty() returns the identifier property for this type
java.lang.String	getName() Returns the name of this WhiteBoard.
EnumeratedValue[]	getTags() returns the tags, if any, attached to this story the returned array may be of size 0, but is never null
java.lang.String	getVersionMetadata() Return the version metadata of this revision
java.lang.String	getVersionMetadataIDs() Return the version metadata of this revision
int	getWhiteBoardID() Returns the whiteboard id.
void	setColor(java.lang.String color) set the color of the WhiteBoard
void	setDescription(java.lang.String description) set the description of the WhiteBoard
void	setName(java.lang.String name) set the name of the WhiteBoard
void	setTags(EnumeratedValue[] tags) sets the tags to be assigned to this story 0, 1 or more tags may be assigned or reassigned

Methods inherited from class com.starteam.Item.WebCacheItem

addNotifiedUser, copy, create, getChangePackages, getIdentifier, getNotifiedUsers, getParentFolder, getRestoredShare, moveTo, moveTo, removeNotifiedUser, shareTo

Methods inherited from class com.starteam.ViewMember.WebCacheViewMember

getAttachments, getComment, getDeletedBy, getDeletedTime, getDisplayValue, getDotNotation, getExternalID, getExternalURL, getHistory, getLabels, getLinks, getLocker, getPresentationID, getRights, getShareTree, getTracedResources, getTraces, getView, getViewMemberRevisions, isBookmarked, isDeleted, isFloating, isPinned, isUnread, lock, lock, modifyBookmark, modifyReadStatus, pinTo, setAttachments, setComment, setExternalID, setExternalURL, setRights, toRESTUrl, unlock, unpin, updateRevisionComment

Methods inherited from class com.starteam.VersionedObject.WebCacheVersionedObject

getRevisionNumber, getRootObjectID, getShortComment, getViewVersion, isFromHistory, setShortComment

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, getNameProperty, 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

getIdentifierProperty

public IntegerProperty.WebCacheIntegerProperty getIdentifierProperty()

returns the identifier property for this type

Specified by:

getIdentifierProperty in interface ArtifactCacheManager.Identifiable

Overrides:

getIdentifierProperty in class Item.WebCacheItem

Returns:

the identifier property for this type

create

public static WhiteBoard.WebCacheWhiteBoard create(ArtifactCacheManager.Context cntxt,
                                                   Folder.WebCacheFolder parent)

Creates a WhiteBoard on the server. This WhiteBoard may be saved by assigning the various properties and then calling update() on the WebCacheWhiteBoard object, or it may be added to a WebCacheViewMemberCollection, which is then saved in a transacted context.

Parameters:

cntxt - the ArtifactCacheManager User Session Context

parent - the parent folder in which this new folder will be created. The parent folder should be from the artifact cache

Returns:

the newly created WhiteBoard.WebCacheWhiteBoard, wrapping a new WhiteBoard

getVersionMetadata

public java.lang.String getVersionMetadata()

Return the version metadata of this revision

Returns:

the version metadata of this revision

getVersionMetadataIDs

public java.lang.String getVersionMetadataIDs()

Return the version metadata of this revision

Returns:

the version metadata of this revision

getName

public java.lang.String getName()

Returns the name of this WhiteBoard.

Specified by:

getName in interface ArtifactCacheManager.Nameable

Overrides:

getName in class LiveObject.WebCacheLiveObject

Returns:

the name of this WhiteBoard.

See Also:

LiveObject.Type.NameProperty.NAME

setName

public void setName(java.lang.String name)

set the name of the WhiteBoard

Parameters:

name - set the name of the WhiteBoard

getWhiteBoardID

public int getWhiteBoardID()

Returns the whiteboard id.

Returns:

the whiteboard id.

See Also:

WhiteBoard.Type.PropertyCollection#WHITEBOARD_ID

getColor

public java.lang.String getColor()

Returns the color of this WhiteBoard.

Returns:

the color of this WhiteBoard.

See Also:

WhiteBoard.Type.ColorProperty.NAME

setColor

public void setColor(java.lang.String color)

set the color of the WhiteBoard

Parameters:

color - set the color of the WhiteBoard

getDescription

public java.lang.String getDescription()

Returns the description of this WhiteBoard.

Returns:

the description of this WhiteBoard.

See Also:

LiveObject.Type.DescriptionProperty.NAME

setDescription

public void setDescription(java.lang.String description)

set the description of the WhiteBoard

Parameters:

description - set the description of the WhiteBoard

getTags

public EnumeratedValue[] getTags()

returns the tags, if any, attached to this story the returned array may be of size 0, but is never null

Returns:

the tags, if any attached to this story instance

setTags

public void setTags(EnumeratedValue[] tags)

sets the tags to be assigned to this story 0, 1 or more tags may be assigned or reassigned

Parameters:

tags - the tags to be assigned to this story instance