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:

Cloneable, Searchable, Serializable

public class Space

extends ConfluenceEntityObject

implements Searchable

See Also:

Serialized Form

Field Summary

protected static org.apache.log4j.Category	log
static String	PERSONAL_SPACEKEY_IDENTIFIER

Constructor Summary

Space()

Space(String spaceKey)

Method Summary

void	addPageTemplate(PageTemplate pageTemplate)
void	addPermission(SpacePermission permission)
Object	clone()
boolean	equals(Object o)
List	getBlogPosts() Deprecated. use spaceManager.getBlogPosts(space, false) instead
List	getCurrentBlogPosts() Deprecated. use spaceManager.getBlogPosts(space, true) instead
List	getCurrentMail() Deprecated. use spageManager.getMail(space, false) instead.
List	getCurrentPages() Deprecated. use spaceManager.getPages(space, true) instead
SpaceDescription	getDescription()
Page	getHomePage()
String	getKey()
List	getMail() Deprecated. use spageManager.getMail(space, false) instead.
String	getName()
List	getPages() Deprecated. use spaceManager.getPages(space, false) instead
List	getPageTemplates()
List	getPermissions()
Collection	getSearchableDependants() only here because the interface needs it like this.
SpaceGroup	getSpaceGroup()
SpaceType	getSpaceType()
SpaceType	getType() Deprecated. use getSpaceType()
String	getUrlPath()
int	hashCode()
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	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 permissions)
void	setSpaceGroup(SpaceGroup spaceGroup)
void	setSpaceManager(SpaceManager spaceManager)
void	setSpaceType(SpaceType spaceType)

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

getCreatorName, getLastModifierName, isPersistent, setCreatorName, 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, toString, wait, wait, wait

Methods inherited from interface com.atlassian.bonnie.Searchable

getId

Field Detail

PERSONAL_SPACEKEY_IDENTIFIER

public static final String PERSONAL_SPACEKEY_IDENTIFIER

See Also:

Constant Field Values

log

protected static org.apache.log4j.Category log

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)

getType

public SpaceType getType()

Deprecated. use getSpaceType()

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)

getPages

public List getPages()

Deprecated. use spaceManager.getPages(space, false) instead

getCurrentPages

public List getCurrentPages()

Deprecated. use spaceManager.getPages(space, true) instead

getBlogPosts

public List getBlogPosts()

Deprecated. use spaceManager.getBlogPosts(space, false) instead

getCurrentBlogPosts

public List getCurrentBlogPosts()

Deprecated. use spaceManager.getBlogPosts(space, true) instead

getPermissions

public List getPermissions()

setPermissions

public void setPermissions(List permissions)

addPermission

public void addPermission(SpacePermission permission)

removePermission

public void removePermission(SpacePermission permission)

getPageTemplates

public List getPageTemplates()

addPageTemplate

public void addPageTemplate(PageTemplate pageTemplate)

removePageTemplate

public void removePageTemplate(PageTemplate pageTemplate)

getMail

public List getMail()

Deprecated. use spageManager.getMail(space, false) instead.

getCurrentMail

public List getCurrentMail()

Deprecated. use spageManager.getMail(space, false) instead.

equals

public boolean equals(Object o)

hashCode

public int hashCode()

clone

public Object clone()
             throws CloneNotSupportedException

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 Searchable

isIndexable

public boolean isIndexable()

Specified by:

isIndexable in interface Searchable

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

getUrlPath

public String getUrlPath()

isPersonal

public boolean isPersonal()

isGlobal

public boolean isGlobal()

getSpaceGroup

public SpaceGroup getSpaceGroup()

setSpaceGroup

public void setSpaceGroup(SpaceGroup spaceGroup)