Space (Atlassian Confluence 7.12.0 API)

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, Serializable, Cloneable
```
public class Space
extends ConfluenceEntityObject
implements com.atlassian.bonnie.Searchable, Addressable
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String CONTENT_TYPE

static int MAX_SPACE_NAME_LENGTH

static String PERSONAL_SPACEKEY_IDENTIFIER

Fields
Modifier and Type	Field and Description
`static String`	`CONTENT_TYPE`
`static int`	`MAX_SPACE_NAME_LENGTH`
`static String`	`PERSONAL_SPACEKEY_IDENTIFIER`

Constructor Summary

Constructors
Constructor and Description

Space()

Space(String spaceKey)

Constructors
Constructor and Description
`Space()`
`Space(String spaceKey)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addPageTemplate(PageTemplate pageTemplate)`
`void`	`addPermission(SpacePermission permission)`
`Object`	`clone()`
`boolean`	`equals(Object o)`
`String`	`getAdvancedTabUrlPath()`
`String`	`getBlogTabUrlPath()`
`String`	`getBrowseUrlPath()`
`URI`	`getDeepLinkUri()` This method returns a link directly to the space homepage.
`Message`	`getDefaultHomepageTitle()`
`SpaceDescription`	`getDescription()`
`String`	`getDisplayTitle()`
`Page`	`getHomePage()`
`String`	`getKey()`
`String`	`getLowerKey()`
`String`	`getName()`
`List`	`getPageTemplates()`
`List<SpacePermission>`	`getPermissions()`
`Collection`	`getSearchableDependants()` only here because the interface needs it like this.
`SpaceGroup`	`getSpaceGroup()` Deprecated. in 5.9. `SpaceGroup` and related classes like `SpaceGroupManager` and `SpaceGroupComparator` will be removed. Please do not use them.
`SpaceStatus`	`getSpaceStatus()`
`SpaceType`	`getSpaceType()`
`String`	`getType()`
`String`	`getUrlPath()`
`int`	`hashCode()`
`boolean`	`isArchived()`
`boolean`	`isGlobal()`
`boolean`	`isIndexable()`
`boolean`	`isPersonal()`
`static boolean`	`isValidGlobalSpaceKey(String key)`
`static boolean`	`isValidPersonalSpaceKey(String key)`
`static boolean`	`isValidSpaceKey(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(String key)`
`void`	`setName(String name)`
`void`	`setPermissions(List<SpacePermission> permissions)`
`void`	`setSpaceGroup(SpaceGroup spaceGroup)` Deprecated. in 5.9. `SpaceGroup` and related classes like `SpaceGroupManager` and `SpaceGroupComparator` will be removed. Please do not use them.
`void`	`setSpaceManager(SpaceManager spaceManager)` Deprecated. since 7.5 remove in 8.0
`void`	`setSpaceStatus(SpaceStatus spaceStatus)`
`void`	`setSpaceType(SpaceType spaceType)`
`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 String PERSONAL_SPACEKEY_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE
```
public static final String CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - MAX_SPACE_NAME_LENGTH
```
public static final int MAX_SPACE_NAME_LENGTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Space
```
public Space()
```
  - Space
```
public Space(String spaceKey)
```
- Method Detail
  - isValidSpaceKey
```
public static boolean isValidSpaceKey(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(String key)
```
  - isValidPersonalSpaceKey
```
public static boolean isValidPersonalSpaceKey(String key)
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getKey
```
public String getKey()
```
  - setKey
```
public void setKey(String key)
```
  - getLowerKey
```
public String getLowerKey()
```
  - 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 List<SpacePermission> getPermissions()
```
  - setPermissions
```
public void setPermissions(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 List getPageTemplates()
```
  - addPageTemplate
```
public void addPageTemplate(PageTemplate pageTemplate)
```
  - removePageTemplate
```
public void removePageTemplate(PageTemplate pageTemplate)
```
  - equals
```
public boolean equals(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 Object clone()
             throws CloneNotSupportedException
```
    Overrides:
    
    clone in class com.atlassian.core.bean.EntityObject
    
    Throws:
    
    CloneNotSupportedException
  - getSearchableDependants
```
public 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
```
@Deprecated
public void setSpaceManager(SpaceManager spaceManager)
```
    Deprecated. since 7.5 remove in 8.0
  - getUrlPath
```
public String getUrlPath()
```
    Specified by:
    
    getUrlPath in interface Addressable
  - getDeepLinkUri
```
public URI getDeepLinkUri()
```
    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.
  - getBrowseUrlPath
```
public String getBrowseUrlPath()
```
  - getAdvancedTabUrlPath
```
public String getAdvancedTabUrlPath()
```
  - getBlogTabUrlPath
```
public String getBlogTabUrlPath()
```
  - getDisplayTitle
```
public String getDisplayTitle()
```
    Specified by:
    
    getDisplayTitle in interface Addressable
    
    Returns:
    
    the title of the addressable object, suitable for display in a list
  - getType
```
public String getType()
```
    Specified by:
    
    getType in interface ContentTypeAware
    
    Returns:
    
    the content type
  - isPersonal
```
public boolean isPersonal()
```
  - isGlobal
```
public boolean isGlobal()
```
  - getSpaceGroup
```
@Deprecated
public SpaceGroup getSpaceGroup()
```
    Deprecated. in 5.9.
    SpaceGroup and related classes like SpaceGroupManager and SpaceGroupComparator will be removed. Please do not use them.
  - setSpaceGroup
```
@Deprecated
public void setSpaceGroup(SpaceGroup spaceGroup)
```
    Deprecated. in 5.9.
    SpaceGroup and related classes like SpaceGroupManager and SpaceGroupComparator will be removed. Please do not use them.
  - getSpaceStatus
```
public SpaceStatus getSpaceStatus()
```
  - setSpaceStatus
```
public void setSpaceStatus(SpaceStatus spaceStatus)
```
  - getDefaultHomepageTitle
```
public Message getDefaultHomepageTitle()
```
  - isArchived
```
public boolean isArchived()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Space

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class com.atlassian.core.bean.EntityObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlassian.bonnie.Searchable

Methods inherited from interface com.atlassian.confluence.core.Addressable

Field Detail

PERSONAL_SPACEKEY_IDENTIFIER

CONTENT_TYPE

MAX_SPACE_NAME_LENGTH

Constructor Detail

Space

Space

Method Detail

isValidSpaceKey

isValidGlobalSpaceKey

isValidPersonalSpaceKey

getName

setName

getKey

setKey

getLowerKey

getSpaceType

setSpaceType

getDescription

setDescription

getHomePage

setHomePage

getPermissions

setPermissions

addPermission

removePermission

removeAllPermissions

getPageTemplates

addPageTemplate

removePageTemplate

equals

hashCode

clone

getSearchableDependants

isIndexable

setSpaceManager

getUrlPath

getDeepLinkUri

getBrowseUrlPath

getAdvancedTabUrlPath

getBlogTabUrlPath

getDisplayTitle

getType

isPersonal

isGlobal

getSpaceGroup

setSpaceGroup

getSpaceStatus

setSpaceStatus

getDefaultHomepageTitle

isArchived

toString