Package com.atlassian.confluence.spaces

Class ReadOnlySpace

java.lang.Object

com.atlassian.core.bean.EntityObject

com.atlassian.confluence.core.ConfluenceEntityObject

com.atlassian.confluence.spaces.Space

com.atlassian.confluence.spaces.ReadOnlySpace

All Implemented Interfaces:

Searchable, Addressable, ContentTypeAware, Serializable, Cloneable

public class ReadOnlySpace
extends Space

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.atlassian.confluence.spaces.Space

CONTENT_TYPE, MAX_SPACE_NAME_LENGTH, PERSONAL_SPACEKEY_IDENTIFIER

Constructor Summary

Constructors

Constructor	Description
ReadOnlySpace(Space delegate)

Method Summary

Modifier and Type	Method	Description
void	addPageTemplate(PageTemplate pageTemplate)
void	addPermission(SpacePermission permission)
Object	clone()
boolean	equals(Object o)
String	getAdvancedTabUrlPath()
String	getBlogTabUrlPath()
String	getBrowseUrlPath()
Date	getCreationDate()
ConfluenceUser	getCreator()
String	getCreatorName()
Date	getCurrentDate()
URI	getDeepLinkUri()	This method returns a link directly to the space homepage.
Message	getDefaultHomepageTitle()
SpaceDescription	getDescription()
String	getDisplayTitle()
Page	getHomePage()
long	getId()
String	getKey()
Date	getLastModificationDate()
ConfluenceUser	getLastModifier()
String	getLastModifierName()
String	getLowerKey()
String	getName()
List	getPageTemplates()
List<SpacePermission>	getPermissions()
Collection	getSearchableDependants()	only here because the interface needs it like this.
SpaceGroup	getSpaceGroup()
SpaceStatus	getSpaceStatus()
SpaceType	getSpaceType()
String	getType()
String	getUrlPath()
int	hashCode()
boolean	isArchived()
boolean	isGlobal()
boolean	isIndexable()	Allows an object to tell the search indexer that it is not allowed to be indexed
boolean	isPersistent()	This object is persistent if the id is not 0.
boolean	isPersonal()
void	removeAllPermissions()	Remove all permissions from this Space
void	removePageTemplate(PageTemplate pageTemplate)
void	removePermission(SpacePermission permission)
void	setClock(com.atlassian.core.util.Clock clock)
void	setCreationDate(Date creationDate)
void	setCreator(ConfluenceUser creator)
void	setCreatorName(String creatorName)	Set the username of the creator
void	setDescription(SpaceDescription description)
void	setHomePage(Page homePage)
void	setId(long id)
void	setKey(String key)
void	setLastModificationDate(Date lastModificationDate)
void	setLastModifier(ConfluenceUser lastModifier)
void	setLastModifierName(String lastModifierName)
void	setName(String name)
void	setPermissions(List<SpacePermission> permissions)
void	setSpaceGroup(SpaceGroup spaceGroup)
void	setSpaceManager(SpaceManager spaceManager)
void	setSpaceStatus(SpaceStatus spaceStatus)
void	setSpaceType(SpaceType spaceType)
String	toString()

Methods inherited from class com.atlassian.confluence.spaces.Space

isValidGlobalSpaceKey, isValidPersonalSpaceKey, isValidSpaceKey

Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject

getRealClass

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ReadOnlySpace

public ReadOnlySpace(Space delegate)

Method Details

getId

public long getId()

Specified by:

getId in interface Addressable

Specified by:

getId in interface Searchable

Overrides:

getId in class com.atlassian.core.bean.EntityObject

setId

public void setId(long id)

Overrides:

setId in class com.atlassian.core.bean.EntityObject

getCreationDate

public Date getCreationDate()

Overrides:

getCreationDate in class com.atlassian.core.bean.EntityObject

setCreationDate

public void setCreationDate(Date creationDate)

Overrides:

setCreationDate in class com.atlassian.core.bean.EntityObject

getLastModificationDate

public Date getLastModificationDate()

Overrides:

getLastModificationDate in class com.atlassian.core.bean.EntityObject

setLastModificationDate

public void setLastModificationDate(Date lastModificationDate)

Overrides:

setLastModificationDate in class com.atlassian.core.bean.EntityObject

setClock

public void setClock(com.atlassian.core.util.Clock clock)

Overrides:

setClock in class com.atlassian.core.bean.EntityObject

getCurrentDate

public Date getCurrentDate()

Overrides:

getCurrentDate in class com.atlassian.core.bean.EntityObject

getName

public String getName()

Overrides:

getName in class Space

setName

public void setName(String name)

Overrides:

setName in class Space

getKey

public String getKey()

Overrides:

getKey in class Space

setKey

public void setKey(String key)

Overrides:

setKey in class Space

getLowerKey

public String getLowerKey()

Overrides:

getLowerKey in class Space

getSpaceType

public SpaceType getSpaceType()

Overrides:

getSpaceType in class Space

setSpaceType

public void setSpaceType(SpaceType spaceType)

Overrides:

setSpaceType in class Space

getDescription

public SpaceDescription getDescription()

Overrides:

getDescription in class Space

setDescription

public void setDescription(SpaceDescription description)

Overrides:

setDescription in class Space

getHomePage

public Page getHomePage()

Overrides:

getHomePage in class Space

setHomePage

public void setHomePage(Page homePage)

Overrides:

setHomePage in class Space

getPermissions

public List<SpacePermission> getPermissions()

Overrides:

getPermissions in class Space

setPermissions

public void setPermissions(List<SpacePermission> permissions)

Overrides:

setPermissions in class Space

addPermission

public void addPermission(SpacePermission permission)

Overrides:

addPermission in class Space

removePermission

public void removePermission(SpacePermission permission)

Overrides:

removePermission in class Space

removeAllPermissions

public void removeAllPermissions()

Description copied from class: Space

Remove all permissions from this Space

Overrides:

removeAllPermissions in class Space

getPageTemplates

public List getPageTemplates()

Overrides:

getPageTemplates in class Space

addPageTemplate

public void addPageTemplate(PageTemplate pageTemplate)

Overrides:

addPageTemplate in class Space

removePageTemplate

public void removePageTemplate(PageTemplate pageTemplate)

Overrides:

removePageTemplate in class Space

equals

public boolean equals(Object o)

Overrides:

equals in class Space

hashCode

public int hashCode()

Overrides:

hashCode in class Space

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Space

Throws:

CloneNotSupportedException

getSearchableDependants

public Collection getSearchableDependants()

Description copied from class: Space

only here because the interface needs it like this. When a space gets deleted, all content with a space index matching to the space will be unindexed. Therefore we don't need to retrieve the searchable dependants with this function.

Specified by:

getSearchableDependants in interface Searchable

Overrides:

getSearchableDependants in class Space

isIndexable

public boolean isIndexable()

Description copied from interface: Searchable

Allows an object to tell the search indexer that it is not allowed to be indexed

Specified by:

isIndexable in interface Searchable

Overrides:

isIndexable in class Space

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

Overrides:

setSpaceManager in class Space

getUrlPath

public String getUrlPath()

Specified by:

getUrlPath in interface Addressable

Overrides:

getUrlPath in class Space

getDeepLinkUri

public URI getDeepLinkUri()

Description copied from class: Space

This method returns a link directly to the space homepage. It is not safe to persist this link as the space homepage can change. If no space homepage is defined, it falls back to getUrlPath() above.

Overrides:

getDeepLinkUri in class Space

getBrowseUrlPath

public String getBrowseUrlPath()

Overrides:

getBrowseUrlPath in class Space

getAdvancedTabUrlPath

public String getAdvancedTabUrlPath()

Overrides:

getAdvancedTabUrlPath in class Space

getBlogTabUrlPath

public String getBlogTabUrlPath()

Overrides:

getBlogTabUrlPath in class Space

getDisplayTitle

public String getDisplayTitle()

Specified by:

getDisplayTitle in interface Addressable

Overrides:

getDisplayTitle in class Space

Returns:

the title of the addressable object, suitable for display in a list

getType

public String getType()

Specified by:

getType in interface ContentTypeAware

Overrides:

getType in class Space

Returns:

the content type

isPersonal

public boolean isPersonal()

Overrides:

isPersonal in class Space

isGlobal

public boolean isGlobal()

Overrides:

isGlobal in class Space

getSpaceGroup

public SpaceGroup getSpaceGroup()

Overrides:

getSpaceGroup in class Space

setSpaceGroup

public void setSpaceGroup(SpaceGroup spaceGroup)

Overrides:

setSpaceGroup in class Space

getSpaceStatus

public SpaceStatus getSpaceStatus()

Overrides:

getSpaceStatus in class Space

setSpaceStatus

public void setSpaceStatus(SpaceStatus spaceStatus)

Overrides:

setSpaceStatus in class Space

getDefaultHomepageTitle

public Message getDefaultHomepageTitle()

Overrides:

getDefaultHomepageTitle in class Space

isArchived

public boolean isArchived()

Overrides:

isArchived in class Space

toString

public String toString()

Overrides:

toString in class Space

getCreatorName

public String getCreatorName()

Overrides:

getCreatorName in class ConfluenceEntityObject

Returns:

username of the creator, or null if created anonymously

getCreator

public ConfluenceUser getCreator()

Overrides:

getCreator in class ConfluenceEntityObject

setCreatorName

public void setCreatorName(String creatorName)

Description copied from class: ConfluenceEntityObject

Set the username of the creator

Overrides:

setCreatorName in class ConfluenceEntityObject

getLastModifierName

public String getLastModifierName()

Overrides:

getLastModifierName in class ConfluenceEntityObject

Returns:

username of the last modifier, or null if none.

getLastModifier

public ConfluenceUser getLastModifier()

Overrides:

getLastModifier in class ConfluenceEntityObject

setLastModifierName

public void setLastModifierName(String lastModifierName)

Overrides:

setLastModifierName in class ConfluenceEntityObject

setCreator

public void setCreator(ConfluenceUser creator)

Overrides:

setCreator in class ConfluenceEntityObject

setLastModifier

public void setLastModifier(ConfluenceUser lastModifier)

Overrides:

setLastModifier in class ConfluenceEntityObject

isPersistent

public boolean isPersistent()

Description copied from class: ConfluenceEntityObject

This object is persistent if the id is not 0.

Overrides:

isPersistent in class ConfluenceEntityObject

Returns:

true if this instance is a persisted label.