Class AnyRoom

java.lang.Object
eu.c6.gibraltar.api.common.CObject
eu.c6.gibraltar.api.managers.rooms.AnyRoom
All Implemented Interfaces:
ICObject, IAnyRoom, IApiRoomConstants, Serializable, Cloneable

public class AnyRoom extends CObject implements IAnyRoom, IApiRoomConstants
The Class AnyRoom to get, create and update folders.
See Also:
  • Constructor Details

    • AnyRoom

      public AnyRoom()
      Instantiates a new any room.
    • AnyRoom

      public AnyRoom(ICObject object)
      Instantiates a new any room from object with fields.
      Parameters:
      object - the object
    • AnyRoom

      public AnyRoom(com.fasterxml.jackson.databind.JsonNode jsonNode)
      Instantiates a new any room from JSON node.
      Parameters:
      jsonNode - the JSON node
  • Method Details

    • getId

      public String getId()
      Description copied from interface: IAnyRoom
      Gets identifier of the room.
      Specified by:
      getId in interface IAnyRoom
      Returns:
      the identifier. When you get the object from the server the identifier is the global unique identifier.
    • setId

      public void setId(String id)
      Description copied from interface: IAnyRoom
      Sets the identifier of the folder. Not used when you create or update. It is only for internal use by the API.
      Specified by:
      setId in interface IAnyRoom
      Parameters:
      id - the room global unique identifier
    • getName

      public String getName()
      Description copied from interface: IAnyRoom
      Gets the room name.
      Specified by:
      getName in interface IAnyRoom
      Returns:
      the room name
    • setName

      public void setName(String name)
      Description copied from interface: IAnyRoom
      Sets the room name.

      Required when you create a new room. It must only contains letters and numbers in lower case, no special characters are accepted.

      Specified by:
      setName in interface IAnyRoom
      Parameters:
      name - the new name
    • getBrowsingMode

      public String getBrowsingMode()
      Description copied from interface: IAnyRoom
      Gets the browsing mode.
      Specified by:
      getBrowsingMode in interface IAnyRoom
      Returns:
      the browsing mode ("flat", "folders" or "mixed")
    • setBrowsingMode

      public void setBrowsingMode(String mode)
      Description copied from interface: IAnyRoom
      Sets the browsing mode.
      Specified by:
      setBrowsingMode in interface IAnyRoom
      Parameters:
      mode - the new browsing mode ("flat", "folders" or "mixed")
    • getViewers

      public List<ApiMember> getViewers()
      Description copied from interface: IAnyRoom
      Gets the viewers. Viewers are user allowed to see the room but cannot browse them until access request is accepted.
      Specified by:
      getViewers in interface IAnyRoom
      Returns:
      the viewers
    • setViewers

      public void setViewers(List<ApiMember> members)
      Description copied from interface: IAnyRoom
      Sets the viewers. Viewers are user allowed to see the room but cannot browse them until access request is accepted.
      Specified by:
      setViewers in interface IAnyRoom
      Parameters:
      members - the new viewers. Each member can be a group or a user.
    • getContributors

      public List<ApiMember> getContributors()
      Description copied from interface: IAnyRoom
      Gets the contributors.
      Specified by:
      getContributors in interface IAnyRoom
      Returns:
      the members of contributors
    • setContributors

      public void setContributors(List<ApiMember> members)
      Description copied from interface: IAnyRoom
      Sets the contributors.
      Specified by:
      setContributors in interface IAnyRoom
      Parameters:
      members - the new contributors. Each member can be a group or a user.
    • getReaders

      public List<ApiMember> getReaders()
      Description copied from interface: IAnyRoom
      Gets the readers.
      Specified by:
      getReaders in interface IAnyRoom
      Returns:
      the members of readers
    • setReaders

      public void setReaders(List<ApiMember> members)
      Description copied from interface: IAnyRoom
      Sets the readers.
      Specified by:
      setReaders in interface IAnyRoom
      Parameters:
      members - the new readers. Each member can be a group or a user.
    • getAdministrators

      public List<ApiMember> getAdministrators()
      Description copied from interface: IAnyRoom
      Gets the administrators.
      Specified by:
      getAdministrators in interface IAnyRoom
      Returns:
      the members of administrators
    • setAdministrators

      public void setAdministrators(List<ApiMember> members)
      Description copied from interface: IAnyRoom
      Sets the administrators.
      Specified by:
      setAdministrators in interface IAnyRoom
      Parameters:
      members - the new administrators. Each member can be a group or a user.
    • setTitles

      public void setTitles(Map<Locale,String> titles)
      Description copied from interface: IAnyRoom
      Sets the room localized titles displayed in Any.
       Example
       
      Specified by:
      setTitles in interface IAnyRoom
      Parameters:
      titles - the localized titles
    • setDescriptions

      public void setDescriptions(Map<Locale,String> descriptions)
      Description copied from interface: IAnyRoom
      Sets the localized descriptions.
      Specified by:
      setDescriptions in interface IAnyRoom
      Parameters:
      descriptions - the localized descriptions
    • setCollections

      public void setCollections(List<String> list)
      Description copied from interface: IAnyRoom
      Sets the collections used in the room.
      Specified by:
      setCollections in interface IAnyRoom
      Parameters:
      list - the new collections
    • setVersion

      public void setVersion(String version)
      Description copied from interface: IAnyRoom
      Sets the version of contents displayed in the room.

      Do not set it if you want to display all versions. Use "latest" value if you want to only display latest versions.

      Specified by:
      setVersion in interface IAnyRoom
      Parameters:
      version - the new version to use
    • setControlledView

      public void setControlledView(String controlledConfig)
      Description copied from interface: IAnyRoom
      Sets the controlled view configuration to use in the room if you want to drive configuration at room level.
      Specified by:
      setControlledView in interface IAnyRoom
      Parameters:
      controlledConfig - the new controlled view configuration to use
    • setControlledPrint

      public void setControlledPrint(String controlledConfig)
      Description copied from interface: IAnyRoom
      Sets the controlled print configuration to use in the room if you want to drive configuration at room level.
      Specified by:
      setControlledPrint in interface IAnyRoom
      Parameters:
      controlledConfig - the new controlled print configuration to use
    • setControlledExport

      public void setControlledExport(String controlledConfig)
      Description copied from interface: IAnyRoom
      Sets the controlled export configuration to use in the room if you want to drive configuration at room level.
      Specified by:
      setControlledExport in interface IAnyRoom
      Parameters:
      controlledConfig - the new controlled export configuration to use
    • setColorization

      public void setColorization(String colorization)
      Description copied from interface: IAnyRoom
      Sets the colorization configuration to use in the room if you want to drive configuration at room level.
      Specified by:
      setColorization in interface IAnyRoom
      Parameters:
      colorization - the new colorization configuration to use
    • setViewsConfig

      public void setViewsConfig(List<IView> views)
      Description copied from interface: IAnyRoom
      Sets the views to use in the room.

      Only compatible with browsing mode IApiRoomConstants.BROWSING_MODE_VIEWS or IApiRoomConstants.BROWSING_MODE_MIXED

      Specified by:
      setViewsConfig in interface IAnyRoom
      Parameters:
      views - the new views config
    • setMassupdateMetadata

      public void setMassupdateMetadata(List<String> metadata)
      Description copied from interface: IAnyRoom
      Sets the metadata list you can update with mass update feature.
      Specified by:
      setMassupdateMetadata in interface IAnyRoom
      Parameters:
      metadata - the new mass update metadata list
    • setReadersPermissions

      public void setReadersPermissions(List<String> permissions)
      Description copied from interface: IAnyRoom
      Sets the additional readers ACL permissions in the room.
      Specified by:
      setReadersPermissions in interface IAnyRoom
      Parameters:
      permissions - the new readers permissions. Possible values are "content:change_state", "content:properties:edit" or "content:comment:*"
    • setImgResourceId

      public void setImgResourceId(String imgresourceid)
      Description copied from interface: IAnyRoom
      Sets the image resource identifier used to display room.
      Specified by:
      setImgResourceId in interface IAnyRoom
      Parameters:
      imgresourceid - the new image resource identifier. Image resource must refer to an existing room image imported in Any.
    • setColumns

      public void setColumns(String type, List<ApiColumn> columns)
      Description copied from interface: IAnyRoom
      Sets the columns to use in the room for main contents or relations.
      Specified by:
      setColumns in interface IAnyRoom
      Parameters:
      type - the type. Possible values are "main" or "relations".
      columns - the columns
    • setRssFeedEnabled

      public void setRssFeedEnabled(boolean enabled)
      Description copied from interface: IAnyRoom
      Sets the RSS feed enabled value.
      Specified by:
      setRssFeedEnabled in interface IAnyRoom
      Parameters:
      enabled - the new RSS feed enabled value.
    • setOnlyVerifiedContentsAllowed

      public void setOnlyVerifiedContentsAllowed(boolean enabled)
      Description copied from interface: IAnyRoom
      Sets the only verified contents allowed value. When only verified content is allowed any content linked or created in the room must match a least a collection of the room.
      Specified by:
      setOnlyVerifiedContentsAllowed in interface IAnyRoom
      Parameters:
      enabled - the new only verified contents allowed value
    • setStaticLinkForbidden

      public void setStaticLinkForbidden(boolean enabled)
      Description copied from interface: IAnyRoom
      Sets the static link forbidden value. When static link is forbidden you cannot manually add a content to the room.
      Specified by:
      setStaticLinkForbidden in interface IAnyRoom
      Parameters:
      enabled - the new static link forbidden value