Interface FolderService

    • Method Detail

      • create

        WSFolder create​(String sid,
                        WSFolder folder)
                 throws Exception
        Creates a new folder. The user can completely customize the folder through a value object containing the folder's metadata
        Parameters:
        sid - Session identifier
        folder - value object containing the folder's metadata
        Returns:
        The value object containing the folder's metadata
        Throws:
        Exception - error during folder creation
      • createAlias

        WSFolder createAlias​(String sid,
                             long parentId,
                             long foldRef)
                      throws Exception
        Creates a new folder alias
        Parameters:
        sid - Session identifier
        parentId - The parent folder
        foldRef - The referenced folder
        Returns:
        The newly created alias
        Throws:
        Exception - error during alias creation
      • createFolder

        long createFolder​(String sid,
                          long parentId,
                          String name)
                   throws Exception
        Create a new folder.
        Parameters:
        sid - Session identifier
        parentId - The parent's ID
        name - The new folder's name
        Returns:
        The newly created folder ID
        Throws:
        Exception - error during folder creation
      • delete

        void delete​(String sid,
                    long folderId)
             throws Exception
        Deletes an existing folder.
        Parameters:
        sid - Session identifier
        folderId - The folder id
        Throws:
        Exception - error in the server application
      • rename

        void rename​(String sid,
                    long folderId,
                    String name)
             throws Exception
        Renames an existing folder.
        Parameters:
        sid - Session identifier
        folderId - The folder id
        name - The new folder name
        Throws:
        Exception - error during folder rename
      • update

        void update​(String sid,
                    WSFolder folder)
             throws Exception
        Updates an existing folder. To perform this you need the RENAME permission.
        Parameters:
        sid - Session identifier
        folder - The folders metadata(please compile the ID)
        Throws:
        Exception - error during update
      • move

        void move​(String sid,
                  long folderId,
                  long parentId)
           throws Exception
        Moves an existing folder with the given identifier.
        Parameters:
        sid - Session identifier
        folderId - The folder id
        parentId - The folder id of the new parent folder
        Throws:
        Exception - error in the server application
      • copy

        void copy​(String sid,
                  long folderId,
                  long targetId,
                  int foldersOnly,
                  int inheritSecurity)
           throws Exception
        Copies an existing folder with the given identifier.
        Parameters:
        sid - Session identifier
        folderId - The folder id
        targetId - The folder id of the target folder
        foldersOnly - If 1, only the folders will be copied and not the documents
        inheritSecurity - If 1, the new folders will inherit the target's security policies
        Throws:
        Exception - error during copy
      • getFolder

        WSFolder getFolder​(String sid,
                           long folderId)
                    throws Exception
        Gets an existing folder
        Parameters:
        sid - Session identifier
        folderId - The folder id
        Returns:
        A value object containing the folder's metadata
        Throws:
        Exception - error in the server application
      • getRootFolder

        WSFolder getRootFolder​(String sid)
                        throws Exception
        Gets root metadata
        Parameters:
        sid - Session identifier
        Returns:
        A value object containing the folder's metadata
        Throws:
        Exception - error in the server application
      • getDefaultWorkspace

        WSFolder getDefaultWorkspace​(String sid)
                              throws Exception
        Gets the Default workspace
        Parameters:
        sid - Session identifier
        Returns:
        A value object containing the workspace's metadata
        Throws:
        Exception - error in the server application
      • isReadable

        boolean isReadable​(String sid,
                           long folderId)
                    throws Exception
        Tests if a folder is readable.
        Parameters:
        sid - Session identifier
        folderId - The folder id
        Returns:
        True if the identifier denotes a readable folder, otherwise false.
        Throws:
        Exception - error in the server application
      • isWritable

        boolean isWritable​(String sid,
                           long folderId)
                    throws Exception
        Tests if a folder is writable
        Parameters:
        sid - Session identifier
        folderId - The folder id
        Returns:
        True if the identifier denotes a writable folder, otherwise false
        Throws:
        Exception - error in the server application
      • isGranted

        boolean isGranted​(String sid,
                          long folderId,
                          int permission)
                   throws Exception
        Tests if the current user has a specific permission on a folder
        Parameters:
        sid - Session identifier
        folderId - The folder id
        permission - The permission representation
        Returns:
        True if the identifier denotes a granted permission, otherwise false
        Throws:
        Exception - error in the server application
      • listChildren

        WSFolder[] listChildren​(String sid,
                                long folderId)
                         throws Exception
        Lists all direct folders of a parent folder.
        Attention: readable only sub-folders are returned.
        Parameters:
        sid - identifier of th session
        folderId - identifier of the folder
        Returns:
        Array of folders contained in the folder
        Throws:
        Exception - error in the server application
      • getPath

        WSFolder[] getPath​(String sid,
                           long folderId)
                    throws Exception
        Computes the path from the root to the target folder.
        Parameters:
        sid - Session identifier
        folderId - The target folder id
        Returns:
        The list of folder, the first is the root, the last is the target folder
        Throws:
        Exception - error in the server application
      • grantUser

        void grantUser​(String sid,
                       long folderId,
                       long userId,
                       int permissions,
                       boolean recursive)
                throws Exception
        Grants user permission to the folder.
        Parameters:
        sid - Session identifier
        folderId - Folder id
        userId - User Id
        permissions - the permission integer representation. If '0', the user will be not granted to access the folder.
        recursive - recursion option. If true, the grant operation is applied also to the subfolders.
        Throws:
        Exception - error in the server application
      • grantGroup

        void grantGroup​(String sid,
                        long folderId,
                        long groupId,
                        int permissions,
                        boolean recursive)
                 throws Exception
        Grants group permission to the folder
        Parameters:
        sid - Session identifier
        folderId - Folder id
        groupId - Group Id
        permissions - the permission integer representation. If '0', the group will be not granted to access the folder.
        recursive - recursion option. If true, the grant operation is applied also to the subfolders
        Throws:
        Exception - error in the server application
      • getGrantedUsers

        WSRight[] getGrantedUsers​(String sid,
                                  long folderId)
                           throws Exception
        Retrieves the list of granted users for the given folder.
        Parameters:
        sid - Session identifier
        folderId - Folder id
        Returns:
        'error' if error occurred, the right objects collection.
        Throws:
        Exception - error in the server application
      • getGrantedGroups

        WSRight[] getGrantedGroups​(String sid,
                                   long folderId)
                            throws Exception
        Retrieves the list of granted groups for the given folder
        Parameters:
        sid - Session identifier
        folderId - Folder id
        Returns:
        'error' if error occurred, the right objects collection
        Throws:
        Exception - error in the server application
      • createPath

        WSFolder createPath​(String sid,
                            long parentId,
                            String path)
                     throws Exception
        Creates the folder for the specified path. All unexisting nodes specified in the path will be created
        Parameters:
        sid - Session identifier
        parentId - The parent folder
        path - The folder's path(for example /Default/dog/cat/mouse)
        Returns:
        The created folder
        Throws:
        Exception - error in the server application
      • findByPath

        WSFolder findByPath​(String sid,
                            String path)
                     throws Exception
        Finds the folder at the specified path
        Parameters:
        sid - Session identifier
        path - The folder's path(for example /Default/dog/cat/mouse)
        Returns:
        The created folder
        Throws:
        Exception - error in the server application
      • listWorkspaces

        WSFolder[] listWorkspaces​(String sid)
                           throws Exception
        Retrieves the list of all workspaces.
        Parameters:
        sid - Session identifier
        Returns:
        the list of all workspaces
        Throws:
        Exception - error in the server application