com.atlassian.confluence.spaces
Class Space

java.lang.Object
  com.atlassian.core.bean.EntityObject
      com.atlassian.confluence.core.ConfluenceEntityObject
          com.atlassian.confluence.spaces.Space

All Implemented Interfaces:

com.atlassian.bonnie.Searchable, Addressable, ContentTypeAware, java.io.Serializable, java.lang.Cloneable

public class Space
extends ConfluenceEntityObject
implements com.atlassian.bonnie.Searchable, Addressable

See Also:

Serialized Form

Field Summary

static java.lang.String	CONTENT_TYPE
protected static org.apache.log4j.Logger	log Deprecated. Since 3.1, use private logger
static java.lang.String	PERSONAL_SPACEKEY_IDENTIFIER

Constructor Summary

Space()

Space(java.lang.String spaceKey)

Method Summary

void	addPageTemplate(PageTemplate pageTemplate)
void	addPermission(SpacePermission permission)
java.lang.Object	clone()
boolean	equals(java.lang.Object o)
java.lang.String	getAdvancedTabUrlPath()
java.lang.String	getBlogTabUrlPath()
java.lang.String	getBrowseUrlPath()
Message	getDefaultHomepageTitle()
SpaceDescription	getDescription()
java.lang.String	getDisplayTitle()
Page	getHomePage()
java.lang.String	getKey()
java.lang.String	getName()
java.util.List	getPageTemplates()
java.util.List<SpacePermission>	getPermissions()
java.util.Collection	getSearchableDependants() only here because the interface needs it like this.
SpaceGroup	getSpaceGroup()
SpaceStatus	getSpaceStatus()
SpaceType	getSpaceType()
java.lang.String	getType()
java.lang.String	getUrlPath()
int	hashCode()
boolean	isArchived()
boolean	isGlobal()
boolean	isIndexable()
boolean	isPersonal()
static boolean	isValidGlobalSpaceKey(java.lang.String key)
static boolean	isValidPersonalSpaceKey(java.lang.String key)
static boolean	isValidSpaceKey(java.lang.String key) Is the key a valid space key of any type? Tests validity of both personal and global space keys
void	removeAllPermissions() Remove all permissions from this Space
void	removePageTemplate(PageTemplate pageTemplate)
void	removePermission(SpacePermission permission)
void	setDescription(SpaceDescription description)
void	setHomePage(Page homePage)
void	setKey(java.lang.String key)
void	setName(java.lang.String name)
void	setPermissions(java.util.List<SpacePermission> permissions)
void	setSpaceGroup(SpaceGroup spaceGroup)
void	setSpaceManager(SpaceManager spaceManager)
void	setSpaceStatus(SpaceStatus spaceStatus)
void	setSpaceType(SpaceType spaceType)
java.lang.String	toString()

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

getCreator, getCreatorName, getLastModifier, getLastModifierName, getRealClass, isPersistent, setCreator, setCreatorName, setLastModifier, setLastModifierName

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

Field Detail

PERSONAL_SPACEKEY_IDENTIFIER

public static final java.lang.String PERSONAL_SPACEKEY_IDENTIFIER

See Also:

Constant Field Values

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

See Also:

Constant Field Values

log

@Deprecated
protected static final org.apache.log4j.Logger log

Deprecated. Since 3.1, use private logger

Constructor Detail

Space

public Space()

Space

public Space(java.lang.String spaceKey)

Method Detail

isValidSpaceKey

public static boolean isValidSpaceKey(java.lang.String key)

Is the key a valid space key of any type? Tests validity of both personal and global space keys

isValidGlobalSpaceKey

public static boolean isValidGlobalSpaceKey(java.lang.String key)

isValidPersonalSpaceKey

public static boolean isValidPersonalSpaceKey(java.lang.String key)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getKey

public java.lang.String getKey()

setKey

public void setKey(java.lang.String key)

getSpaceType

public SpaceType getSpaceType()

setSpaceType

public void setSpaceType(SpaceType spaceType)

getDescription

public SpaceDescription getDescription()

setDescription

public void setDescription(SpaceDescription description)

getHomePage

public Page getHomePage()

setHomePage

public void setHomePage(Page homePage)

getPermissions

public java.util.List<SpacePermission> getPermissions()

setPermissions

public void setPermissions(java.util.List<SpacePermission> permissions)

addPermission

public void addPermission(SpacePermission permission)

removePermission

public void removePermission(SpacePermission permission)

removeAllPermissions

public void removeAllPermissions()

Remove all permissions from this Space

Since:

5.5

getPageTemplates

public java.util.List getPageTemplates()

addPageTemplate

public void addPageTemplate(PageTemplate pageTemplate)

removePageTemplate

public void removePageTemplate(PageTemplate pageTemplate)

equals

public boolean equals(java.lang.Object o)

Overrides:

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

hashCode

public int hashCode()

Overrides:

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

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

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

Throws:

java.lang.CloneNotSupportedException

getSearchableDependants

public java.util.Collection getSearchableDependants()

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 com.atlassian.bonnie.Searchable

isIndexable

public boolean isIndexable()

Specified by:

isIndexable in interface com.atlassian.bonnie.Searchable

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

getUrlPath

public java.lang.String getUrlPath()

Specified by:

getUrlPath in interface Addressable

getBrowseUrlPath

public java.lang.String getBrowseUrlPath()

getAdvancedTabUrlPath

public java.lang.String getAdvancedTabUrlPath()

getBlogTabUrlPath

public java.lang.String getBlogTabUrlPath()

getDisplayTitle

public java.lang.String getDisplayTitle()

Specified by:

getDisplayTitle in interface Addressable

Returns:

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

getType

public java.lang.String getType()

Specified by:

getType in interface ContentTypeAware

Returns:

the content type

isPersonal

public boolean isPersonal()

isGlobal

public boolean isGlobal()

getSpaceGroup

public SpaceGroup getSpaceGroup()

setSpaceGroup

public void setSpaceGroup(SpaceGroup spaceGroup)

getSpaceStatus

public SpaceStatus getSpaceStatus()

setSpaceStatus

public void setSpaceStatus(SpaceStatus spaceStatus)

getDefaultHomepageTitle

public Message getDefaultHomepageTitle()

isArchived

public boolean isArchived()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object