public class

UserStatus

extends SpaceContentEntityObject
java.lang.Object
   ↳ com.atlassian.core.bean.EntityObject
     ↳ com.atlassian.confluence.core.ConfluenceEntityObject
       ↳ com.atlassian.confluence.core.AbstractVersionedEntityObject
         ↳ com.atlassian.confluence.core.AbstractLabelableEntityObject
           ↳ com.atlassian.confluence.core.ContentEntityObject
             ↳ com.atlassian.confluence.core.SpaceContentEntityObject
               ↳ com.atlassian.confluence.userstatus.UserStatus

Class Overview

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

Summary

Constants
String CONTENT_TYPE
[Expand]
Inherited Constants
From class com.atlassian.confluence.core.ContentEntityObject
From class com.atlassian.confluence.core.AbstractVersionedEntityObject
Public Constructors
UserStatus()
Creates an empty status object
UserStatus(String username, String statusText, Space targetSpace)
UserStatus(String username, String statusText)
UserStatus(User user, String status, Space targetSpace)
UserStatus(User user, String status)
Public Methods
String getClearPath()
ContentEntityObject getContentEntityObject()
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()
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)
[Expand]
Inherited Methods
From class com.atlassian.confluence.core.SpaceContentEntityObject
From class com.atlassian.confluence.core.ContentEntityObject
From class com.atlassian.confluence.core.AbstractLabelableEntityObject
From class com.atlassian.confluence.core.AbstractVersionedEntityObject
From class com.atlassian.confluence.core.ConfluenceEntityObject
From class com.atlassian.core.bean.EntityObject
From class java.lang.Object
From interface com.atlassian.bonnie.Searchable
From interface com.atlassian.confluence.content.Content
From interface com.atlassian.confluence.core.Addressable
From interface com.atlassian.confluence.core.ContentTypeAware
From interface com.atlassian.confluence.core.Versioned
From interface com.atlassian.confluence.labels.EditableLabelable
From interface com.atlassian.confluence.labels.Labelable
From interface com.atlassian.confluence.spaces.Spaced
From interface java.lang.Comparable

Constants

public static final String CONTENT_TYPE

Constant Value: "status"

Public Constructors

public UserStatus ()

Creates an empty status object

public UserStatus (String username, String statusText, Space targetSpace)

public UserStatus (String username, String statusText)

public UserStatus (User user, String status, Space targetSpace)

public UserStatus (User user, String status)

Public Methods

public String getClearPath ()

public ContentEntityObject getContentEntityObject ()

public String getDeletePath ()

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

public 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.

public String getStatus ()

public 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.

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.

public String getUrlPath ()

public boolean isCurrent ()

public 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

public void setStatus (String status)