com.atlassian.confluence.spaces
Class SpaceDescription
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.core.SpaceContentEntityObject
com.atlassian.confluence.spaces.SpaceDescription
- All Implemented Interfaces:
- com.atlassian.bonnie.Searchable, Addressable, ContentTypeAware, Versioned, Labelable, Spaced, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable
public class SpaceDescription
- extends SpaceContentEntityObject
- See Also:
- Serialized Form
Method Summary |
java.lang.String |
getDisplayTitle()
Returns the display title. |
java.lang.String |
getSpaceKey()
|
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 |
isPersonalSpace()
|
Methods inherited from class com.atlassian.confluence.core.ContentEntityObject |
addAttachment, addComment, addLabelling, addOutgoingLink, addPermission, addReferralLink, clone, compareTo, equals, getAttachmentNamed, getAttachments, getAttachmentsUrlPath, getBodyContents, getComments, getContent, getContentPermission, getContentPermissionSet, getContentStatus, getExcerpt, getGlobalLabels, getIdAsString, getLabelCount, getLabellings, getLabels, getLabelsForDisplay, getLabelUtil, getLatestVersionsOfAttachments, getOutgoingLinks, getPermissions, getPersonalLabels, getReferralLinks, getRenderedVersionComment, getSearchableDependants, getTitle, getTrackbackLinks, getUserAccessor, getVersionComment, getVisibleLabels, hasContentPermissions, hasPermissions, isCurrent, isDeleted, isFavourite, isRecentlyUpdatedFor, isVersionCommentAvailable, removeAttachment, removeComment, removeContentPermissionSet, removeLabelling, removeOutgoingLink, removeReferralLink, removeTrackbackLink, setAttachments, setBodyContents, setComments, 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 |
log
@Deprecated
public static final org.apache.log4j.Logger log
- Deprecated.
CONTENT_TYPE_SPACEDESC
public static final java.lang.String CONTENT_TYPE_SPACEDESC
- See Also:
- Constant Field Values
CONTENT_TYPE_PERSONAL_SPACEDESC
public static final java.lang.String CONTENT_TYPE_PERSONAL_SPACEDESC
- See Also:
- Constant Field Values
SpaceDescription
public SpaceDescription()
SpaceDescription
public SpaceDescription(Space space)
getDisplayTitle
public java.lang.String getDisplayTitle()
- Description copied from class:
ContentEntityObject
- 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.
- Specified by:
getDisplayTitle
in interface Addressable
- Overrides:
getDisplayTitle
in class ContentEntityObject
- Returns:
- the display title
getUrlPath
public java.lang.String getUrlPath()
- Specified by:
getUrlPath
in interface Addressable
- Specified by:
getUrlPath
in class ContentEntityObject
- Returns:
- a link to the home page of the associated space
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
getSpaceKey
public java.lang.String getSpaceKey()
- Overrides:
getSpaceKey
in class SpaceContentEntityObject
isPersonalSpace
public boolean isPersonalSpace()
Copyright © 2003-2010 Atlassian. All Rights Reserved.