Class AnyFolder

java.lang.Object
eu.c6.gibraltar.api.common.CObject
eu.c6.gibraltar.api.managers.folders.AnyFolder
All Implemented Interfaces:
ICObject, IAnyFolder, IAnyFolderConstants, Serializable, Cloneable

public class AnyFolder extends CObject implements IAnyFolder, IAnyFolderConstants
The Class AnyFolder to get, create and update folders.
See Also:
  • Constructor Details

    • AnyFolder

      public AnyFolder()
      Instantiates a new any folder.
    • AnyFolder

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

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

    • getId

      public String getId()
      Description copied from interface: IAnyFolder
      Gets identifier of the folder.
      Specified by:
      getId in interface IAnyFolder
      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: IAnyFolder
      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 IAnyFolder
      Parameters:
      id - the folder global unique identifier
    • getParentId

      public String getParentId()
      Description copied from interface: IAnyFolder
      Gets the parent identifier. Can be a folder identifier or a room identifier if you are at the top level of the folder tree.
      Specified by:
      getParentId in interface IAnyFolder
      Returns:
      the parent id
    • setParentId

      public void setParentId(String parentId)
      Description copied from interface: IAnyFolder
      Sets the parent identifier.

      Not used when you create or update. It is only for internal use by the API. Can be a folder identifier or a room identifier if you are at the top level of the folder tree.

      Specified by:
      setParentId in interface IAnyFolder
      Parameters:
      parentId - the new parent identifier
    • isAllowEdit

      public boolean isAllowEdit()
      Description copied from interface: IAnyFolder
      Checks if the folder allows edit for current user.
      Specified by:
      isAllowEdit in interface IAnyFolder
      Returns:
      true, if current user can edit
    • setAllowEdit

      public void setAllowEdit(boolean allowEdit)
      Description copied from interface: IAnyFolder
      Sets the allow edit value. Only for internal use by the API, you cannot set it in Any with the API.
      Specified by:
      setAllowEdit in interface IAnyFolder
      Parameters:
      allowEdit - the new allow edit value
    • hasSecurityOverwrite

      public boolean hasSecurityOverwrite()
      Description copied from interface: IAnyFolder
      Checks if the folder has security overwrite
      Specified by:
      hasSecurityOverwrite in interface IAnyFolder
      Returns:
      true, if folder has security overwrite
    • setSecurityOverwrite

      public void setSecurityOverwrite(boolean overwrite)
      Description copied from interface: IAnyFolder
      Sets the security overwrite value.
      Specified by:
      setSecurityOverwrite in interface IAnyFolder
      Parameters:
      overwrite - the new allow edit value
    • getContributors

      public List<ApiMember> getContributors()
      Description copied from interface: IAnyFolder
      Gets folder contributors list if security is overwritten.
      Specified by:
      getContributors in interface IAnyFolder
      Returns:
      List of members. Each member can be a group or user.
    • setContributors

      public void setContributors(List<ApiMember> members)
      Description copied from interface: IAnyFolder
      Sets the list of contributors members. Only used if security is overwritten.
      Specified by:
      setContributors in interface IAnyFolder
      Parameters:
      members - the new list of user/group members.
    • getName

      public String getName()
      Description copied from interface: IAnyFolder
      Gets the folder name.
      Specified by:
      getName in interface IAnyFolder
      Returns:
      the folder name used in folder path
    • setName

      public void setName(String name)
      Description copied from interface: IAnyFolder
      Sets the folder name.

      You must distinguish the folder name and the folder titles. Folder titles are the nice localized labels displayed in Any and the folder name is used to build unique folder path into the room.

      Specified by:
      setName in interface IAnyFolder
      Parameters:
      name - the new name
    • setTitles

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

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