Class XWikiSpace


  • public class XWikiSpace
    extends Object
    Represent a space.
    Since:
    7.2M1
    Version:
    $Id: a8cb38aa4a56724f974280787951b1ed1e0f9159 $
    • 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
    • Method Detail

      • setStore

        public void setStore​(XWikiStoreInterface store)
        Set the store of the space.
        Parameters:
        store - the store to set.
        Since:
        12.5RC1
      • getId

        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