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:
- com.atlassian.bonnie.Searchable, Addressable, ContentTypeAware, Versioned, Labelable, java.io.Serializable, java.lang.Cloneable, java.lang.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
Constructor Summary |
UserStatus()
Creates an empty status object |
UserStatus(java.lang.String username,
java.lang.String statusText)
|
UserStatus(com.atlassian.user.User user,
java.lang.String status)
|
Method Summary |
java.lang.String |
getClearPath()
|
java.lang.String |
getDeletePath()
|
java.lang.String |
getFullName()
This field is here so that search can access
the full name without using the useraccessor every time |
java.lang.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. |
java.lang.String |
getStatus()
|
java.lang.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. |
java.lang.String |
getUrlPath()
|
boolean |
isCurrent()
|
boolean |
isIndexable()
Content entity objects that are historical versions should not be indexed. |
void |
setStatus(java.lang.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.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 |
CONTENT_TYPE
public static final java.lang.String CONTENT_TYPE
- See Also:
- Constant Field Values
UserStatus
public UserStatus()
- Creates an empty status object
UserStatus
public UserStatus(java.lang.String username,
java.lang.String statusText)
UserStatus
public UserStatus(com.atlassian.user.User user,
java.lang.String status)
getStatus
public java.lang.String getStatus()
setStatus
public void setStatus(java.lang.String status)
getFullName
public java.lang.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 java.lang.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 java.lang.String getUrlPath()
- Specified by:
getUrlPath
in interface Addressable
- Specified by:
getUrlPath
in class ContentEntityObject
getDeletePath
public java.lang.String getDeletePath()
getClearPath
public java.lang.String getClearPath()
getNameForComparison
public java.lang.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 com.atlassian.bonnie.Searchable
- Overrides:
isIndexable
in class ContentEntityObject
Copyright © 2003-2010 Atlassian. All Rights Reserved.