com.atlassian.confluence.setup.settings
Class GlobalDescription
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
- All Implemented Interfaces:
- com.atlassian.bonnie.Searchable, Addressable, Versioned, Labelable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable
public class GlobalDescription
- extends ContentEntityObject
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.
- See Also:
- Serialized Form
Method Summary |
java.lang.String |
getDisplayTitle()
The title of the addressable object, suitable for display in a list |
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 |
getSiteWelcomeMessage()
|
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()
The object does not have any "payload" now therefore there is no right
way of implementing this method. |
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, getExcerpt, getGlobalLabels, getIdAsString, getLabelCount, getLabellings, getLabels, getLabelsForDisplay, getLabelUtil, getLatestVersionsOfAttachments, getOutgoingLinks, getPermissions, getPersonalLabels, getRealTitle, getReferralLinks, getRenderedVersionComment, getSearchableDependants, getTitle, getTrackbackLinks, getUserAccessor, getVersionComment, getVisibleLabels, hasContentPermissions, hashCode, hasPermissions, isCurrent, isDeleted, isFavourite, isIndexable, 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 |
GlobalDescription
public GlobalDescription()
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
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 Addressable
- Specified by:
getType
in class ContentEntityObject
getUrlPath
public java.lang.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.
- Specified by:
getUrlPath
in interface Addressable
- Specified by:
getUrlPath
in class ContentEntityObject
getDisplayTitle
public java.lang.String getDisplayTitle()
- Description copied from interface:
Addressable
- The title of the addressable object, suitable for display in a list
- Specified by:
getDisplayTitle
in interface Addressable
- Overrides:
getDisplayTitle
in class ContentEntityObject
- Returns:
getSiteWelcomeMessage
public java.lang.String getSiteWelcomeMessage()
Copyright © 2003-2008 Atlassian Pty Ltd. All Rights Reserved.