com.starteam
Class Topic

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

All Implemented Interfaces:

ISecurable, Lockable, LockableObject, java.lang.Cloneable

public class Topic
extends TreeItem

Represents a StarTeam Topic.

Nested Class Summary

static class	Topic.Priority Priority of the Topic
static class	Topic.Status Status of the Topic
static class	Topic.TopicType Type of the Topic
static class	Topic.Type Type meta-data (schema) for Topic object instances.
static class	Topic.WebCacheTopic Item accessor for cached SDK Topic items contained objects are obtained from the artifact cache

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

TreeItem.MoSCoW, TreeItem.WebCacheTreeItem

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

Constructor Summary

Topic(Topic parentTopic)
Creates a new topic that is a subtopic of an existing topic.

Method Summary

void	addRecipient(User user) Adds the specified user object as a recipient for this topic.
boolean	amIRecipient() Returns a value indicating whether the logged on user is a recipient of this topic.
static Topic	create(Folder prnt) Create a Topic in the specified parent folder.
int	getNumber() Returns the topic number of this topic.
int	getParentTopic() Gets the ObjectID of this topic's parent topic.
Topic.Priority	getPriority() Returns the Priority of this topic.
Topic.Type.PropertyCollection	getProperties() Gets the PropertyCollection for this Topic.
int	getRecipientCount() Returns the number of recipients assigned to this topic.
User[]	getRecipients() Returns the IDs of the users assigned as recipients of this topic.
Topic.Status	getStatus() Returns the Status of this topic.
java.lang.String	getText() Returns the text or body of the topic.
java.lang.String	getTitle() Returns the title or subject of the topic.
void	removeRecipient(User user) Removes the specified user object as a recipient from this topic.
void	setPriority(Topic.Priority priority) Sets the Priority of this topic.
void	setStatus(Topic.Status status) Sets the Status of this topic.
void	setText(java.lang.String text) Sets the text or body of this topic.
void	setTitle(java.lang.String title) Sets the title or subject of this topic.
java.lang.String	toString() Returns the title of this topic.

Methods inherited from class com.starteam.TreeItem

createChild, getChildren, getOrderProperty, getParent, getParentID, hasChildren, isEqualTo, moveTo, moveTo, remove, setAfter, setBefore, setBetween, setFirst, setLast, shareTo, smartShareTo, update

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, recordMergePoint, resolve, resolveMergePoint, resolveMergePointEx, reverseShareTo, reverseShareTo

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

Constructor Detail

Topic

public Topic(Topic parentTopic)

Creates a new topic that is a subtopic of an existing topic.

Parameters:

parentTopic - The parent topic.

Method Detail

getProperties

public Topic.Type.PropertyCollection getProperties()

Gets the PropertyCollection for this Topic.

create

public static Topic create(Folder prnt)

Create a Topic in the specified parent folder.

Parameters:

prnt - the parent folder

Returns:

a new Topic Object.

getParentTopic

public int getParentTopic()

Gets the ObjectID of this topic's parent topic.

Returns:

The ObjectID of this topic's parent topic, or -1 if this is a root topic.

See Also:

Topic.Type.ParentTopicIDProperty.NAME

getTitle

public java.lang.String getTitle()

Returns the title or subject of the topic.

Returns:

The title or subject of the topic.

See Also:

Topic.Type.TitleProperty.NAME

setTitle

public void setTitle(java.lang.String title)

Sets the title or subject of this topic.

Parameters:

title - The new topic title.

getText

public java.lang.String getText()

Returns the text or body of the topic.

Returns:

The text or body of the topic.

See Also:

LiveObject.Type.DescriptionProperty.NAME

setText

public void setText(java.lang.String text)

Sets the text or body of this topic.

Parameters:

text - The new text or body for this topic.

getNumber

public int getNumber()

Returns the topic number of this topic.

Returns:

The topic number of this topic.

See Also:

Topic.Type.TopicNumberProperty.NAME

getPriority

public Topic.Priority getPriority()

Returns the Priority of this topic.

Returns:

The Priority of this topic.

See Also:

Topic.Type.PriorityProperty.NAME

setPriority

public void setPriority(Topic.Priority priority)

Sets the Priority of this topic.

Parameters:

priority - The new Priority for this topic.

getStatus

public Topic.Status getStatus()

Returns the Status of this topic.

Returns:

The Status of this topic.

See Also:

Topic.Type.StatusProperty.NAME

setStatus

public void setStatus(Topic.Status status)

Sets the Status of this topic.

Parameters:

status - The new Status for this topic.

getRecipientCount

public int getRecipientCount()

Returns the number of recipients assigned to this topic.

Returns:

The number of recipients assigned to this topic.

See Also:

Topic.Type.RecipientCountProperty.NAME

getRecipients

public User[] getRecipients()

Returns the IDs of the users assigned as recipients of this topic.

Returns:

The IDs of the users assigned as recipients of this topic.

See Also:

Topic.Type.RecipientsProperty.NAME

addRecipient

public void addRecipient(User user)

Adds the specified user object as a recipient for this topic.

Parameters:

user - the user object to add as a recipient for this topic,

removeRecipient

public void removeRecipient(User user)

Removes the specified user object as a recipient from this topic.

Parameters:

user - the user object recipient to remove from this topic.

amIRecipient

public boolean amIRecipient()

Returns a value indicating whether the logged on user is a recipient of this topic.

Returns:

A value indicating whether the logged on user is a recipient of this topic.

See Also:

Topic.Type.AmIRecipientProperty.NAME, Topic.addRecipient(com.starteam.User), Topic.removeRecipient(com.starteam.User), Topic.getRecipients()

toString

public java.lang.String toString()

Returns the title of this topic.

Overrides:

toString in class Item

Returns:

the title of this topic.