public class

GlobalDescription

extends ContentEntityObject
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.setup.settings.GlobalDescription

Class Overview

Content Entity Object that is associated with the whole confluence rather then a specific space/page/user. Currently this object does not have any pay load and it is only used to attach global logo to it. We only allow one instance of such object.

Summary

[Expand]
Inherited Constants
From class com.atlassian.confluence.core.ContentEntityObject
From class com.atlassian.confluence.core.AbstractVersionedEntityObject
Public Constructors
GlobalDescription()
Public Methods
ContentEntityObject getContentEntityObject()
String getDisplayTitle()
Returns the display title.
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 getSiteWelcomeMessage()
This method is deprecated. since 4.0. Not used.
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()
The object does not have any "payload" now therefore there is no right way of implementing this method.
[Expand]
Inherited Methods
From class com.atlassian.confluence.core.ContentEntityObject
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.core.Addressable
From interface com.atlassian.confluence.core.ContentTypeAware
From interface com.atlassian.confluence.core.Versioned
From interface com.atlassian.confluence.labels.Labelable
From interface java.lang.Comparable

Public Constructors

public GlobalDescription ()

Public Methods

public ContentEntityObject getContentEntityObject ()

public String getDisplayTitle ()

Returns the display title. Some entities don't have titles for identification. For example, personal information objects use the user's fullname. Override this method to provide a custom title.

Returns
  • the display title

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 getSiteWelcomeMessage ()

This method is deprecated.
since 4.0. Not used.

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 ()

The object does not have any "payload" now therefore there is no right way of implementing this method. "/" seems to be most sensible option.