com.starteam
Class Topic.WebCacheTopic

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.TreeItem.WebCacheTreeItem
                          com.starteam.Topic.WebCacheTopic

All Implemented Interfaces:

ArtifactCacheManager.Securable

Enclosing class:

Topic

public static class Topic.WebCacheTopic
extends TreeItem.WebCacheTreeItem

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

Method Summary

void	addRecipient(User.WebCacheUser user) Adds the specified user object as a recipient for this topic.
static Topic.WebCacheTopic	create(ArtifactCacheManager.Context cntxt, Folder.WebCacheFolder parent) Creates a Topic on the server.
static Topic.WebCacheTopic	create(ArtifactCacheManager.Context cntxt, Topic.WebCacheTopic parent) Creates a Topic on the server.
int	getNumber() Returns the topic number of this topic.
Topic.Priority	getPriority() Returns the Priority of this topic.
User.WebCacheUser[]	getRecipients() Returns 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.WebCacheUser 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.

Methods inherited from class com.starteam.TreeItem.WebCacheTreeItem

create, create, getChildren, getParent, hasChildren, moveTo, setAfter, setBefore, setBetween, setFirst, setLast

Methods inherited from class com.starteam.Item.WebCacheItem

create, getLabels, getLinks, getParentFolder, moveTo, moveTo

Methods inherited from class com.starteam.ViewMember.WebCacheViewMember

getAttachments, getComment, getDisplayValue, getDotNotation, getExternalID, getExternalURL, getHistory, getLocker, getPresentationID, getRights, getShareTree, getTraces, getView, isDeleted, isFloating, isPinned, isUnread, lock, lock, modifyReadStatus, pinTo, setAttachments, setExternalID, setExternalURL, setRights, unlock, unpin, updateRevisionComment

Methods inherited from class com.starteam.VersionedObject.WebCacheVersionedObject

getRevisionNumber, getRootObjectID, getViewVersion, isFromHistory

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 Topic.WebCacheTopic create(ArtifactCacheManager.Context cntxt,
                                         Folder.WebCacheFolder parent)

Creates a Topic on the server. This topic may be saved by assigning the various properties and then calling update() on the WebCacheTopic 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 Topic.WebCacheTopic, wrapping a new Topic

create

public static Topic.WebCacheTopic create(ArtifactCacheManager.Context cntxt,
                                         Topic.WebCacheTopic parent)

Creates a Topic on the server. This item may be saved by assigning the various properties and then calling update() on the WebCacheTopic 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 Topic to this new Topic . The parent Topic should be from the artifact cache

Returns:

the newly created Topic.WebCacheTopic, wrapping a new Topic

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.

getRecipients

public User.WebCacheUser[] getRecipients()

Returns the users assigned as recipients of this topic.

Returns:

The users assigned as recipients of this topic.

See Also:

Topic.Type.RecipientsProperty.NAME

addRecipient

public void addRecipient(User.WebCacheUser 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.WebCacheUser user)

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

Parameters:

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