com.atlassian.confluence.userstatus
Class UserStatus

java.lang.Object
  com.atlassian.core.bean.EntityObject
      com.atlassian.confluence.core.ConfluenceEntityObject
          com.atlassian.confluence.core.AbstractVersionedEntityObject
              com.atlassian.confluence.core.ContentEntityObject
                  com.atlassian.confluence.userstatus.UserStatus

All Implemented Interfaces:

Searchable, Addressable, ContentTypeAware, Versioned, Labelable, Serializable, Cloneable, Comparable

public class UserStatus
extends ContentEntityObject

Stores a short message representing a status from a User. Not attached to any space

See Also:

Serialized Form

Field Summary

static String

CONTENT_TYPE

Fields inherited from class com.atlassian.confluence.core.ContentEntityObject

CREATED, CURRENT, DELETED, MODIFIED

Fields inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject

INITIAL_VERSION

Constructor Summary

UserStatus()
Creates an empty status object

UserStatus(String username, String statusText)

UserStatus(User user, String status)

Method Summary

String	getClearPath()
String	getDeletePath()
String	getFullName() This field is here so that search can access the full name without using the useraccessor every time
String	getNameForComparison() Subclasses should implement this method, giving a String back so that the content can be alphabetically sorted in a mixed-type list of content-entities.
String	getStatus()
String	getType() An easy name for the type of this content: makes it easy for things like the #contentLink macro to work out what to draw.
String	getUrlPath()
boolean	isCurrent()
boolean	isIndexable() Content entity objects that are historical versions should not be indexed.
void	setStatus(String status)

Methods inherited from class com.atlassian.confluence.core.ContentEntityObject

addAttachment, addLabelling, addOutgoingLink, addPermission, addReferralLink, addTrackbackLink, clone, compareTo, convertToHistoricalVersion, equals, getAttachmentNamed, getAttachments, getAttachmentsUrlPath, getBodyContents, getContent, getContentPermission, getContentPermissionSet, getContentStatus, getDisplayTitle, getExcerpt, getGlobalLabels, getIdAsString, getLabelCount, getLabellings, getLabels, getLabelsForDisplay, getLabelUtil, getLatestVersionsOfAttachments, getOutgoingLinks, getPermissions, getPersonalLabels, getReferralLinks, getRenderedVersionComment, getSearchableDependants, getTitle, getTrackbackLinks, getUserAccessor, getVersionComment, getVisibleLabels, hasContentPermissions, hashCode, hasPermissions, isDeleted, isFavourite, isRecentlyUpdatedFor, isVersionCommentAvailable, removeAttachment, removeContentPermissionSet, removeLabelling, removeOutgoingLink, removeReferralLink, removeTrackbackLink, setAttachments, setBodyContents, setContent, setContentStatus, setOutgoingLinks, setReferralLinks, setTitle, setTrackbackLinks, setUserAccessor, setVersionComment, toPageContext, toString, trash

Methods inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject

getLatestVersion, getOriginalVersion, getVersion, isLatestVersion, isNew, setOriginalVersion, setVersion

Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject

getCreatorName, getLastModifierName, getRealClass, isPersistent, setCreatorName, setLastModifierName

Methods inherited from class com.atlassian.core.bean.EntityObject

getCreationDate, getCurrentDate, getId, getLastModificationDate, setClock, setCreationDate, setId, setLastModificationDate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.bonnie.Searchable

getId

Methods inherited from interface com.atlassian.confluence.core.Addressable

getId

Field Detail

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UserStatus

public UserStatus()

Creates an empty status object

UserStatus

public UserStatus(String username,
                  String statusText)

UserStatus

public UserStatus(User user,
                  String status)

Method Detail

getStatus

public String getStatus()

setStatus

public void setStatus(String status)

getFullName

public String getFullName()

This field is here so that search can access the full name without using the useraccessor every time

Returns:

the user's full name

isCurrent

public boolean isCurrent()

Overrides:

isCurrent in class ContentEntityObject

getType

public String getType()

Description copied from class: ContentEntityObject

An easy name for the type of this content: makes it easy for things like the #contentLink macro to work out what to draw.

This is a bit of a hack, but it saves heaps of code elsewhere, especially since we tend to get back these objects wrapped in all sorts of Hibernate CGLIB stuff.

Specified by:

getType in interface ContentTypeAware

Specified by:

getType in class ContentEntityObject

Returns:

the content type

getUrlPath

public String getUrlPath()

Specified by:

getUrlPath in interface Addressable

Specified by:

getUrlPath in class ContentEntityObject

getDeletePath

public String getDeletePath()

getClearPath

public String getClearPath()

getNameForComparison

public String getNameForComparison()

Description copied from class: ContentEntityObject

Subclasses should implement this method, giving a String back so that the content can be alphabetically sorted in a mixed-type list of content-entities.

Specified by:

getNameForComparison in class ContentEntityObject

isIndexable

public boolean isIndexable()

Description copied from class: ContentEntityObject

Content entity objects that are historical versions should not be indexed.

Specified by:

isIndexable in interface Searchable

Overrides:

isIndexable in class ContentEntityObject