com.atlassian.confluence.userstatus
Class UserStatus

java.lang.Object
  extended by com.atlassian.core.bean.EntityObject
      extended by com.atlassian.confluence.core.ConfluenceEntityObject
          extended by com.atlassian.confluence.core.AbstractVersionedEntityObject
              extended by com.atlassian.confluence.core.AbstractLabelableEntityObject
                  extended by com.atlassian.confluence.core.ContentEntityObject
                      extended by com.atlassian.confluence.core.SpaceContentEntityObject
                          extended by com.atlassian.confluence.userstatus.UserStatus
All Implemented Interfaces:
com.atlassian.bonnie.Searchable, Content, Addressable, ContentTypeAware, Versioned, EditableLabelable, Labelable, Spaced, Serializable, Cloneable, Comparable

public class UserStatus
extends SpaceContentEntityObject

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(ConfluenceUser user, String status, Space targetSpace)
           
UserStatus(String username, String statusText)
          Deprecated. since 5.2. See UserStatus(ConfluenceUser, String, Space)
UserStatus(String username, String statusText, Space targetSpace)
          Deprecated. since 5.2. See UserStatus(ConfluenceUser, String, Space)
UserStatus(com.atlassian.user.User user, String status)
          Deprecated. since 5.2. See UserStatus(ConfluenceUser, String, Space)
UserStatus(com.atlassian.user.User user, String status, Space targetSpace)
          Deprecated. since 5.2. See UserStatus(ConfluenceUser, String, Space)
 
Method Summary
 String getClearPath()
           
 String getDeletePath()
           
 String getFullName()
          Deprecated. since 5.2. Use ConfluenceEntityObject.getCreator() instead.
 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()
          pages, blogs etc that aren't not associated with a space (either because they are historical or corrupt) should not be indexed if they are indexed, and returned in search results, they are broken and are therefore useless
 void setStatus(String status)
           
 
Methods inherited from class com.atlassian.confluence.core.SpaceContentEntityObject
convertToHistoricalVersion, getSpace, getSpaceKey, hashCode, isInSpace, setSpace
 
Methods inherited from class com.atlassian.confluence.core.ContentEntityObject
addAttachment, addComment, addCustomContent, addOutgoingLink, addPermission, addReferralLink, addTrackbackLink, applyChildVersioningPolicy, clone, compareTo, ensureAttachmentBelongsToContent, equals, getAttachmentNamed, getAttachments, getAttachmentsUrlPath, getAttachmentUrlPath, getBodyAsString, getBodyAsStringWithoutMarkup, getBodyContent, getBodyContent, getBodyContents, getComments, getContainerContent, getContentEntityObject, getContentId, getContentPermission, getContentPermissionSet, getContentStatus, getDefaultBodyType, getDisplayTitle, getEntity, getExcerpt, getIdAsString, getLatestVersionsOfAttachments, getOutgoingLinks, getPermissions, getProperties, getReferralLinks, getRenderedVersionComment, getSearchableDependants, getTitle, getTrackbackLinks, getTypeEnum, getUserAccessor, getVersionComment, hasContentPermissions, hasPermissions, isDeleted, isRecentlyUpdatedFor, isVersionCommentAvailable, removeAttachment, removeComment, removeContentPermissionSet, removeCustomContent, removeOutgoingLink, removeReferralLink, removeTrackbackLink, replaceContentProperties, restore, restoreDependents, setAttachments, setBodyAsString, setBodyContent, setBodyContents, setComments, setContainerContent, setContentStatus, setOutgoingLinks, setReferralLinks, setTitle, setTrackbackLinks, setUserAccessor, setVersionComment, toPageContext, toString, trash, trashDependents
 
Methods inherited from class com.atlassian.confluence.core.AbstractLabelableEntityObject
addLabelling, getGlobalLabels, getLabelCount, getLabellings, getLabels, getLabelsForDisplay, getLabelUtil, getPersonalLabels, getTeamLabels, getVisibleLabels, isFavourite, isFavourite, removeLabelling, setLabellings
 
Methods inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject
getLatestVersion, getOriginalVersion, getVersion, getVersionChildPolicy, isLatestVersion, isNew, setOriginalVersion, setVersion
 
Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject
getCreator, getCreatorName, getLastModifier, getLastModifierName, getRealClass, isPersistent, setCreator, setCreatorName, setLastModifier, 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
 
Methods inherited from interface com.atlassian.confluence.labels.EditableLabelable
getId, isPersistent
 

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

@Deprecated
public UserStatus(String username,
                             String statusText,
                             Space targetSpace)
Deprecated. since 5.2. See UserStatus(ConfluenceUser, String, Space)


UserStatus

@Deprecated
public UserStatus(String username,
                             String statusText)
Deprecated. since 5.2. See UserStatus(ConfluenceUser, String, Space)


UserStatus

@Deprecated
public UserStatus(com.atlassian.user.User user,
                             String status,
                             Space targetSpace)
Deprecated. since 5.2. See UserStatus(ConfluenceUser, String, Space)


UserStatus

@Deprecated
public UserStatus(com.atlassian.user.User user,
                             String status)
Deprecated. since 5.2. See UserStatus(ConfluenceUser, String, Space)


UserStatus

public UserStatus(ConfluenceUser user,
                  String status,
                  Space targetSpace)
Method Detail

getStatus

public String getStatus()

setStatus

public void setStatus(String status)

getFullName

@Deprecated
public String getFullName()
Deprecated. since 5.2. Use ConfluenceEntityObject.getCreator() instead.

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.

Overrides:
getNameForComparison in class SpaceContentEntityObject

isIndexable

public boolean isIndexable()
Description copied from class: SpaceContentEntityObject
pages, blogs etc that aren't not associated with a space (either because they are historical or corrupt) should not be indexed if they are indexed, and returned in search results, they are broken and are therefore useless

Specified by:
isIndexable in interface com.atlassian.bonnie.Searchable
Overrides:
isIndexable in class SpaceContentEntityObject


Copyright © 2003–2015 Atlassian. All rights reserved.