com.xpn.xwiki.doc

Class XWikiSpace

java.lang.Object

com.xpn.xwiki.doc.XWikiSpace

public class XWikiSpace
extends Object

Represent a space.

Since:

7.2M1

Version:

$Id: d72b041ba82b3689ca7b2bdd1900bc7eb8a1be19 $

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XWikiSpace() Required by Hibernate.
	XWikiSpace(SpaceReference reference)
	XWikiSpace(SpaceReference reference, boolean hidden)
	XWikiSpace(SpaceReference reference, XWikiStoreInterface store)

Method Summary

Modifier and Type	Method and Description
long	getId()
static long	getId(SpaceReference spaceReference) Compute a XWikiSpace ID based on a reference.
String	getName()
String	getParent()
String	getReference()
SpaceReference	getSpaceReference()
XWikiStoreInterface	getStore()
boolean	isHidden()
void	setHidden(boolean hidden)
protected void	setId(long id) Required by Hibernate.
protected void	setName(String name) Required by Hibernate.
protected void	setParent(String parent) Required by Hibernate.
protected void	setReference(String reference) Required by Hibernate.
void	setStore(XWikiStoreInterface store) Set the store of the space.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XWikiSpace

protected XWikiSpace()

Required by Hibernate.

XWikiSpace

public XWikiSpace(SpaceReference reference)

Parameters:

reference - the complete reference of the space

XWikiSpace

public XWikiSpace(SpaceReference reference,
                  boolean hidden)

Parameters:

reference - the complete reference of the space

hidden - true if all the documents in the space are hidden

XWikiSpace

public XWikiSpace(SpaceReference reference,
                  XWikiStoreInterface store)

Parameters:

reference - the complete reference of the space

store - the store where the XWikiSpace instance come from

Method Detail

getStore

public XWikiStoreInterface getStore()

Returns:

the store where the XWikiSpace instance come from

setStore

@Unstable
public void setStore(XWikiStoreInterface store)

Set the store of the space.

Parameters:

store - the store to set.

Since:

12.5RC1

getId

@Unstable
public static long getId(SpaceReference spaceReference)

Compute a XWikiSpace ID based on a reference.

Parameters:

spaceReference - the reference from which to compute the ID

Returns:

an ID that can be used to retrieve the space in DB.

Since:

12.5RC1

getId

public long getId()

Returns:

the synthetic id of this deleted document. unique only for document.

setId

protected void setId(long id)

Required by Hibernate.

Parameters:

id - the synthetic id to set.

getName

public String getName()

Returns:

the name of the space.

setName

protected void setName(String name)

Required by Hibernate.

Parameters:

name - the name of the space

getParent

public String getParent()

Returns:

the reference of the space parent

setParent

protected void setParent(String parent)

Required by Hibernate.

Parameters:

parent - the reference of the space parent

getReference

public String getReference()

Returns:

the complete reference of the space

isHidden

public boolean isHidden()

Returns:

true if all the documents in the space are hidden

setHidden

public void setHidden(boolean hidden)

Parameters:

hidden - true if all the documents in the space are hidden

setReference

protected void setReference(String reference)

Required by Hibernate.

Parameters:

reference -

getSpaceReference

public SpaceReference getSpaceReference()

Returns:

the complete reference of the space

toString

public String toString()

Overrides:

toString in class Object