com.starteam
Class WhiteBoard

java.lang.Object
  com.starteam.TypedResource
      com.starteam.LiveObject
          com.starteam.TrackedObject
              com.starteam.VersionedObject
                  com.starteam.ViewMember
                      com.starteam.Item
                          com.starteam.WhiteBoard

All Implemented Interfaces:

ISecurable, Lockable, LockableObject, java.lang.Cloneable

public class WhiteBoard
extends Item

A WhiteBoard is a collection of concepts.

Nested Class Summary

static class	WhiteBoard.Type Type meta-data (schema) for WhiteBoard object instances.
static class	WhiteBoard.WebCacheWhiteBoard Item accessor for cached SDK WhiteBoard items contained objects are obtained from the artifact cache

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

Item.WebCacheItem

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

ViewMember.LockType, ViewMember.MyLock, ViewMember.ShareState, ViewMember.WebCacheViewMember

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

VersionedObject.WebCacheVersionedObject

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

static WhiteBoard	create(Folder prnt) Create a WhiteBoard in the specified parent folder.
java.lang.String	getColor() Returns the Color of this WhiteBoard.
java.lang.String	getDescription() Returns the text in the "Description" property for this WhiteBoard.
java.lang.String	getName() Returns the Name of this WhiteBoard.
WhiteBoard.Type.PropertyCollection	getProperties() Gets the PropertyCollection for 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
int	getWhiteBoardID() Returns the whiteboard id.
void	setColor(java.lang.String color) Sets the Color of this WhiteBoard.
void	setDescription(java.lang.String description) Sets the text in the "Description" property for this WhiteBoard.
void	setName(java.lang.String Name) Sets the Name of this 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

copy, deleteMergePoint, getCommonAncestor, getDebugString, getDisplayableProperties, getItemID, getMergeHistory, getNewRevisionComment, getParentContainer, getParentFolder, getParentFolderHierarchy, getParentFolderName, getParentFolderPath, getParentFolderQualifiedName, getSharedChangePackages, getSharedTraces, isEqualTo, isReverseShareRecommended, moveTo, recordMergePoint, remove, resolve, resolveMergePoint, resolveMergePointEx, reverseShareTo, reverseShareTo, shareTo, smartShareTo, toString

Methods inherited from class com.starteam.ViewMember

equals, findLinks, getAllLabels, getAllShares, getAttachedLabels, getAttachments, getBehavior, getCache, getComment, getDeletedBy, getDeletedTime, getDisplayValue, getDotNotation, getExclusiveLocker, getExternalID, getExternalURL, getFromHistory, getFromHistory, getFromHistory, getFromHistory, getHistory, getID, getIntegerArrayValue, getLocker, getMyLockType, getParentRevision, getPresentationID, getRights, getRootObjectID, getShare, getShare, getTraces, getValue, getView, getViewMemberRevisions, getViewVersion, getVMID, hashCode, hasPermissions, isBookmarked, isBranchable, isDeleted, isDisembodied, isEqualTo, isReadOnly, isRootShare, isUnread, lockExclusive, lockExclusive, lockNonExclusive, modifyBookmark, modifyReadStatus, putLock, setAttachments, setBehavior, setBranchOnChange, setComment, setExternalID, setExternalURL, setFixedConfiguration, setFloatingConfiguration, setRights, setValue, unlock, update, updateRevisionComment

Methods inherited from class com.starteam.VersionedObject

getBranchRevision, getRevisionNumber, getViewVersion, isFromHistory

Methods inherited from class com.starteam.TrackedObject

getModifiedBy, getModifiedTime

Methods inherited from class com.starteam.LiveObject

getCreatedBy, getCreatedTime, toStarTeamURL

Methods inherited from class com.starteam.TypedResource

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.starteam.ISecurable

getServer, getType

Method Detail

create

public static WhiteBoard create(Folder prnt)

Create a WhiteBoard in the specified parent folder.

Parameters:

prnt - the parent folder

Returns:

a new WhiteBoard Object.

getProperties

public WhiteBoard.Type.PropertyCollection getProperties()

Gets the PropertyCollection for this WhiteBoard.

Returns:

the PropertyCollection of its Type

getName

public java.lang.String getName()

Returns the Name of this WhiteBoard.

Returns:

the Name of this WhiteBoard.

See Also:

WhiteBoard.Type.PropertyCollection.NAME

getWhiteBoardID

public int getWhiteBoardID()

Returns the whiteboard id.

Returns:

the whiteboard id.

See Also:

WhiteBoard.Type.PropertyCollection#WHITEBOARD_ID

setName

public void setName(java.lang.String Name)

Sets the Name of this WhiteBoard.

Parameters:

Name - the new Name for this WhiteBoard.

See Also:

WhiteBoard.Type.PropertyCollection.NAME

getColor

public java.lang.String getColor()

Returns the Color of this WhiteBoard.

Returns:

the Color of this WhiteBoard.

See Also:

WhiteBoard.Type.PropertyCollection.COLOR

setColor

public void setColor(java.lang.String color)

Sets the Color of this WhiteBoard.

Parameters:

color - the new color for this WhiteBoard.

See Also:

WhiteBoard.Type.PropertyCollection.COLOR

getDescription

public java.lang.String getDescription()

Returns the text in the "Description" property for this WhiteBoard.

Returns:

the text in the "Description" property for this WhiteBoard.

See Also:

WhiteBoard.Type.PropertyCollection.DESCRIPTION

setDescription

public void setDescription(java.lang.String description)

Sets the text in the "Description" property for this WhiteBoard.

Parameters:

description - the text in the "Description" property for this WhiteBoard.

See Also:

WhiteBoard.Type.PropertyCollection.DESCRIPTION

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

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