Package com.atlassian.confluence.spaces

Class ReadOnlySpace

java.lang.Object
com.atlassian.core.bean.EntityObject
com.atlassian.confluence.core.AnnotatedEntityObject
com.atlassian.confluence.core.ConfluenceEntityObject
com.atlassian.confluence.spaces.Space
com.atlassian.confluence.spaces.ReadOnlySpace
All Implemented Interfaces:
Searchable, Addressable, ContentTypeAware, Serializable, Cloneable
@Deprecated(forRemoval=true) public class ReadOnlySpace extends Space
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1, use Space directly.
See Also:

  • Field Summary

    Fields inherited from class com.atlassian.confluence.spaces.Space

    CONTENT_TYPE, MAX_SPACE_NAME_LENGTH, PERSONAL_SPACEKEY_IDENTIFIER

  • Constructor Summary

    Constructors
    Constructor
    Description
    ReadOnlySpace(Space delegate)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addPageTemplate(PageTemplate pageTemplate)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    addPermission(SpacePermission permission)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Object
    clone()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    equals(Object o)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getAdvancedTabUrlPath()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getBlogTabUrlPath()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getBrowseUrlPath()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Date
    getCreationDate()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    ConfluenceUser
    getCreator()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getCreatorName()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Date
    getCurrentDate()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    URI
    getDeepLinkUri()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method returns a link directly to the space homepage.
    Message
    getDefaultHomepageTitle()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    SpaceDescription
    getDescription()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getDisplayTitle()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Page
    getHomePage()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    long
    getId()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getKey()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Date
    getLastModificationDate()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    ConfluenceUser
    getLastModifier()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getLastModifierName()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getLowerKey()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getName()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    List
    getPageTemplates()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    List<SpacePermission>
    getPermissions()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Collection
    getSearchableDependants()
    Deprecated, for removal: This API element is subject to removal in a future version.
    When we un-index something (say, a page), we also need to un-index everything contained within that page (comments, attachments), because presumably they're all about to go away.
    SpaceGroup
    getSpaceGroup()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    SpaceStatus
    getSpaceStatus()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    SpaceType
    getSpaceType()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getType()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getUrlPath()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    hashCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isArchived()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isGlobal()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isIndexable()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Allows an object to tell the search indexer that it is not allowed to be indexed
    boolean
    isPersistent()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This object is persistent if the id is not 0.
    boolean
    isPersonal()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    removeAllPermissions()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Remove all permissions from this Space
    void
    removePageTemplate(PageTemplate pageTemplate)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    removePermission(SpacePermission permission)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setClock(com.atlassian.core.util.Clock clock)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setCreationDate(Date creationDate)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setCreator(ConfluenceUser creator)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setCreatorName(String creatorName)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the username of the creator
    void
    setDescription(SpaceDescription description)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setHomePage(Page homePage)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setId(long id)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setKey(String key)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setLastModificationDate(Date lastModificationDate)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setLastModifier(ConfluenceUser lastModifier)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setLastModifierName(String lastModifierName)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setName(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setPermissions(List<SpacePermission> permissions)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setSpaceGroup(SpaceGroup spaceGroup)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setSpaceManager(SpaceManager spaceManager)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setSpaceStatus(SpaceStatus spaceStatus)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setSpaceType(SpaceType spaceType)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    toString()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class com.atlassian.confluence.spaces.Space

    isValidGlobalSpaceKey, isValidPersonalSpaceKey, isValidSpaceKey

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

    getRealClass

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ReadOnlySpace

      public ReadOnlySpace(Space delegate)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • getId

      public long getId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getId in interface Addressable
      Specified by:
      getId in interface Searchable
      Overrides:
      getId in class com.atlassian.core.bean.EntityObject

    • setId

      public void setId(long id)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      setId in class com.atlassian.core.bean.EntityObject

    • getCreationDate

      public Date getCreationDate()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getCreationDate in class AnnotatedEntityObject

    • setCreationDate

      public void setCreationDate(Date creationDate)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      setCreationDate in class com.atlassian.core.bean.EntityObject

    • getLastModificationDate

      public Date getLastModificationDate()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getLastModificationDate in class AnnotatedEntityObject

    • setLastModificationDate

      public void setLastModificationDate(Date lastModificationDate)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      setLastModificationDate in class com.atlassian.core.bean.EntityObject

    • setClock

      public void setClock(com.atlassian.core.util.Clock clock)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      setClock in class com.atlassian.core.bean.EntityObject

    • getCurrentDate

      public Date getCurrentDate()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getCurrentDate in class com.atlassian.core.bean.EntityObject

    • getName

      public String getName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getName in class Space

    • setName

      public void setName(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      setName in class Space

    • getKey

      public String getKey()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getKey in class Space

    • setKey

      public void setKey(String key)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      setKey in class Space

    • getLowerKey

      public String getLowerKey()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getLowerKey in class Space

    • getSpaceType

      public SpaceType getSpaceType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getSpaceType in class Space

    • setSpaceType

      public void setSpaceType(SpaceType spaceType)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      setSpaceType in class Space

    • getDescription

      public SpaceDescription getDescription()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getDescription in class Space

    • setDescription

      public void setDescription(SpaceDescription description)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      setDescription in class Space

    • getHomePage

      public Page getHomePage()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getHomePage in class Space

    • setHomePage

      public void setHomePage(Page homePage)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      setHomePage in class Space

    • getPermissions

      public List<SpacePermission> getPermissions()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getPermissions in class Space

    • setPermissions

      public void setPermissions(List<SpacePermission> permissions)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      setPermissions in class Space

    • addPermission

      public void addPermission(SpacePermission permission)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      addPermission in class Space

    • removePermission

      public void removePermission(SpacePermission permission)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      removePermission in class Space

    • removeAllPermissions

      public void removeAllPermissions()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: Space
      Remove all permissions from this Space
      Overrides:
      removeAllPermissions in class Space

    • getPageTemplates

      public List getPageTemplates()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getPageTemplates in class Space

    • addPageTemplate

      public void addPageTemplate(PageTemplate pageTemplate)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      addPageTemplate in class Space

    • removePageTemplate

      public void removePageTemplate(PageTemplate pageTemplate)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      removePageTemplate in class Space

    • equals

      public boolean equals(Object o)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      equals in class Space

    • hashCode

      public int hashCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      hashCode in class Space

    • clone

      public Object clone() throws CloneNotSupportedException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      clone in class Space
      Throws:
      CloneNotSupportedException

    • getSearchableDependants

      public Collection getSearchableDependants()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Searchable
      When we un-index something (say, a page), we also need to un-index everything contained within that page (comments, attachments), because presumably they're all about to go away.

    • isIndexable

      public boolean isIndexable()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Searchable
      Allows an object to tell the search indexer that it is not allowed to be indexed
      Specified by:
      isIndexable in interface Searchable
      Overrides:
      isIndexable in class Space

    • setSpaceManager

      public void setSpaceManager(SpaceManager spaceManager)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      setSpaceManager in class Space

    • getUrlPath

      public String getUrlPath()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getUrlPath in interface Addressable
      Overrides:
      getUrlPath in class Space

    • getDeepLinkUri

      public URI getDeepLinkUri()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: Space
      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.
      Overrides:
      getDeepLinkUri in class Space

    • getBrowseUrlPath

      public String getBrowseUrlPath()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getBrowseUrlPath in class Space

    • getAdvancedTabUrlPath

      public String getAdvancedTabUrlPath()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getAdvancedTabUrlPath in class Space

    • getBlogTabUrlPath

      public String getBlogTabUrlPath()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getBlogTabUrlPath in class Space

    • getDisplayTitle

      public String getDisplayTitle()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getDisplayTitle in interface Addressable
      Overrides:
      getDisplayTitle in class Space
      Returns:
      the title of the addressable object, suitable for display in a list

    • getType

      public String getType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getType in interface ContentTypeAware
      Overrides:
      getType in class Space
      Returns:
      the content type

    • isPersonal

      public boolean isPersonal()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      isPersonal in class Space

    • isGlobal

      public boolean isGlobal()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      isGlobal in class Space

    • getSpaceGroup

      public SpaceGroup getSpaceGroup()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getSpaceGroup in class Space

    • setSpaceGroup

      public void setSpaceGroup(SpaceGroup spaceGroup)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      setSpaceGroup in class Space

    • getSpaceStatus

      public SpaceStatus getSpaceStatus()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getSpaceStatus in class Space

    • setSpaceStatus

      public void setSpaceStatus(SpaceStatus spaceStatus)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      setSpaceStatus in class Space

    • getDefaultHomepageTitle

      public Message getDefaultHomepageTitle()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getDefaultHomepageTitle in class Space

    • isArchived

      public boolean isArchived()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      isArchived in class Space

    • toString

      public String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      toString in class Space

    • getCreatorName

      public String getCreatorName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getCreatorName in class ConfluenceEntityObject
      Returns:
      username of the creator, or null if created anonymously

    • getCreator

      public ConfluenceUser getCreator()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getCreator in class ConfluenceEntityObject

    • setCreatorName

      public void setCreatorName(String creatorName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: ConfluenceEntityObject
      Set the username of the creator
      Overrides:
      setCreatorName in class ConfluenceEntityObject

    • getLastModifierName

      public String getLastModifierName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getLastModifierName in class ConfluenceEntityObject
      Returns:
      username of the last modifier, or null if none.

    • getLastModifier

      public ConfluenceUser getLastModifier()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      getLastModifier in class ConfluenceEntityObject

    • setLastModifierName

      public void setLastModifierName(String lastModifierName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      setLastModifierName in class ConfluenceEntityObject

    • setCreator

      public void setCreator(ConfluenceUser creator)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      setCreator in class ConfluenceEntityObject

    • setLastModifier

      public void setLastModifier(ConfluenceUser lastModifier)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      setLastModifier in class ConfluenceEntityObject

    • isPersistent

      public boolean isPersistent()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: ConfluenceEntityObject
      This object is persistent if the id is not 0.
      Overrides:
      isPersistent in class ConfluenceEntityObject
      Returns:
      true if this instance is a persisted label.