Package com.logicaldoc.gui.frontend.client.services

Interface FolderService

All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
All Known Implementing Classes:
FolderServiceImpl
@RemoteServiceRelativePath("folder") public interface FolderService extends com.google.gwt.user.client.rpc.RemoteService
The client side stub for the Folder Service. This service allows r/w operations on folders.
Since:
6.0
Author:
Marco Meschieri - LogicalDOC

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    FolderService.Instance
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    applyGridLayout(long folderId)
    Replicates the folder's grid layout to all the subtree
    void
    applyMetadata(long parentId)
    Applies all extended attributes to a sub-tree
    void
    applyOCR(long parentId)
    Applies all OCR settings to a sub-tree
    void
    applyStore(long parentId)
    Applies the store setting to a sub-tree
    void
    applyTags(long parentId)
    Applies all tags to a sub-tree
    void
    applyTemplate(long folderId, long templateId, boolean inheritSecurity)
    Applies a template to a folder
    List<Long>
    computeStats(long folderId)
    Counts the docs and subfolders of a given parent
    void
    copyFolders(List<Long> folderIds, long targetId, boolean foldersOnly, String securityOption, GUIFolder model)
    Copies a folder under a target folder
    GUIFolder
    create(GUIFolder newFolder, boolean inheritSecurity)
    Creates a new folder
    GUIFolder
    createAlias(long parentId, long foldRef)
    Creates a new folder alias
    void
    delete(List<Long> folderIds)
    Deletes the folders and the subtrees
    void
    deleteFromTrash(List<Long> ids)
    Deletes a selection of folders from trash
    GUIAccessControlEntry
    getAllowedPermissions(List<Long> folderIds)
    Gets the allowed permissions on a set of folders in regards of the current user
    GUIFolder
    getFolder(long folderId, boolean computePath, boolean computeDocs, boolean computeSubfolders)
    Gets the Folder initializing the permissions.
    GUIFolder
    inheritACL(long folderId, long rightsFolderId)
    Inherits the ACL of another folder
    List<GUIValue>
    loadTemplates()
    Loads the folders templates
    void
    merge(List<Long> folderIds, long targetId)
    Merges some folders to a target folder
    void
    move(List<Long> folderIds, long targetId)
    Moves some folders under a target folder
    void
    paste(List<Long> docIds, long folderId, String action, boolean links, boolean notes, boolean security)
    Pastes documents into the target folder
    void
    pasteAsAlias(List<Long> docIds, long folderId, String type)
     
    String
    readImage()
    Read the uploaded image and converts it into Base64
    void
    rename(long folderId, String name)
    Renames the given folder
    void
    restore(List<Long> folderIds, long targetId)
    Restores a given folder
    GUIFolder
    save(GUIFolder folder)
    Saves the folder in the DB
    void
    saveACL(GUIFolder folder, boolean subfolders)
    Applies all security settings to folder
    void
    saveTemplates(List<GUIValue> templates)
    Saves the passed folder templates
    void
    setFolderPagination(long folderId, Integer startRecord, Integer pageSize)
    Sets the pagination informations for the visualization of the folders tree

  • Method Details

    • save

      GUIFolder save(GUIFolder folder) throws ServerException
      Saves the folder in the DB
      Parameters:
      folder - The folder to save
      Returns:
      The saved folder
      Throws:
      ServerException - an error happened in the server application

    • create

      GUIFolder create(GUIFolder newFolder, boolean inheritSecurity) throws ServerException
      Creates a new folder
      Parameters:
      newFolder - The folder to be created
      inheritSecurity - True if the new folder has to inherit the security policies from the parent
      Returns:
      The saved folder
      Throws:
      ServerException - an error happened in the server application

    • createAlias

      GUIFolder createAlias(long parentId, long foldRef) throws ServerException
      Creates a new folder alias
      Parameters:
      parentId - The folder in which the alias must be created
      foldRef - The original folder
      Returns:
      The created alias
      Throws:
      ServerException - an error happened in the server application

    • rename

      void rename(long folderId, String name) throws ServerException
      Renames the given folder
      Parameters:
      folderId - identifier of the folder
      name - the new folder's name
      Throws:
      ServerException - an error happened in the server application

    • saveACL

      void saveACL(GUIFolder folder, boolean subfolders) throws ServerException
      Applies all security settings to folder
      Parameters:
      folder - The folder that contains the new security settings
      subfolders - If true, the current security settings will be applied to the sub-folders
      Throws:
      ServerException - an error happened in the server application

    • inheritACL

      GUIFolder inheritACL(long folderId, long rightsFolderId) throws ServerException
      Inherits the ACL of another folder
      Parameters:
      folderId - The folder that has to be updated
      rightsFolderId - the folder that defines the rights
      Returns:
      The updated Folder
      Throws:
      ServerException - an error happened in the server application

    • applyMetadata

      void applyMetadata(long parentId) throws ServerException
      Applies all extended attributes to a sub-tree
      Parameters:
      parentId - The parent folder containing the metadata
      Throws:
      ServerException - an error happened in the server application

    • applyTags

      void applyTags(long parentId) throws ServerException
      Applies all tags to a sub-tree
      Parameters:
      parentId - The parent folder containing the tags
      Throws:
      ServerException - an error happened in the server application

    • applyStore

      void applyStore(long parentId) throws ServerException
      Applies the store setting to a sub-tree
      Parameters:
      parentId - The parent folder containing the tags
      Throws:
      ServerException - an error happened in the server application

    • applyOCR

      void applyOCR(long parentId) throws ServerException
      Applies all OCR settings to a sub-tree
      Parameters:
      parentId - The parent folder containing the settings
      Throws:
      ServerException - an error happened in the server application

    • getFolder

      GUIFolder getFolder(long folderId, boolean computePath, boolean computeDocs, boolean computeSubfolders) throws ServerException
      Gets the Folder initializing the permissions.
      Parameters:
      folderId - The folder identifier
      computePath - True if the complete path must be retrieved
      computeDocs - True if the number of contained documents must be computed
      computeSubfolders - True if the number of contained subfolders must be computed
      Returns:
      The Folder bean
      Throws:
      ServerException - an error happened in the server application

    • delete

      void delete(List<Long> folderIds) throws ServerException
      Deletes the folders and the subtrees
      Parameters:
      folderIds - identifiers of the folders
      Throws:
      ServerException - an error happened in the server application

    • deleteFromTrash

      void deleteFromTrash(List<Long> ids) throws ServerException
      Deletes a selection of folders from trash
      Parameters:
      ids - identifiers of the folders
      Throws:
      ServerException - an error happened in the server application

    • restore

      void restore(List<Long> folderIds, long targetId) throws ServerException
      Restores a given folder
      Parameters:
      folderIds - identifiers of the folders
      targetId - identifier of the folder that will receive the restore
      Throws:
      ServerException - an error happened in the server application

    • move

      void move(List<Long> folderIds, long targetId) throws ServerException
      Moves some folders under a target folder
      Parameters:
      folderIds - identifiers of the folders
      targetId - identifier of the folder that will receive the move
      Throws:
      ServerException - an error happened in the server application

    • merge

      void merge(List<Long> folderIds, long targetId) throws ServerException
      Merges some folders to a target folder
      Parameters:
      folderIds - identifiers of the folders
      targetId - identifier of the folder that will receive the merge
      Throws:
      ServerException - an error happened in the server application

    • copyFolders

      void copyFolders(List<Long> folderIds, long targetId, boolean foldersOnly, String securityOption, GUIFolder model) throws ServerException
      Copies a folder under a target folder
      Parameters:
      folderIds - identifiers of the folders
      targetId - identifier of the folder that will receive the copy
      foldersOnly - flag to copy just the folders and not the documents
      securityOption - how to setup the security for the new folder'none', 'inherit' or 'replicate'
      model - a model to use for creating the new folder
      Throws:
      ServerException - an error happened in the server application

    • paste

      void paste(List<Long> docIds, long folderId, String action, boolean links, boolean notes, boolean security) throws ServerException
      Pastes documents into the target folder
      Parameters:
      docIds - the documents identifiers
      folderId - the target folder identifier
      action - the selected action(Clipboard.COPY or Clipboard.COPY)
      links - if the links must be copied too
      notes - if the notes and annotations must be copied too
      security - if the security settings must be copied too
      Throws:
      ServerException - an error happened in the server application

    • pasteAsAlias

      void pasteAsAlias(List<Long> docIds, long folderId, String type) throws ServerException
      Throws:
      ServerException

    • loadTemplates

      List<GUIValue> loadTemplates() throws ServerException
      Loads the folders templates
      Returns:
      the folder templates
      Throws:
      ServerException - an error happened in the server application

    • saveTemplates

      void saveTemplates(List<GUIValue> templates) throws ServerException
      Saves the passed folder templates
      Parameters:
      templates - the folder templates
      Throws:
      ServerException - an error happened in the server application

    • applyTemplate

      void applyTemplate(long folderId, long templateId, boolean inheritSecurity) throws ServerException
      Applies a template to a folder
      Parameters:
      folderId - identifier of the folder to use as root
      templateId - identifier of the template to use
      inheritSecurity - if the new folders mus inherit the security from folderId
      Throws:
      ServerException - an error happened in the server application

    • computeStats

      List<Long> computeStats(long folderId) throws ServerException
      Counts the docs and subfolders of a given parent
      Parameters:
      folderId - identifier of the folder
      Returns:
      the statistics (total number of documents, total number of subfolders, total size
      Throws:
      ServerException - an error happened in the server application

    • setFolderPagination

      void setFolderPagination(long folderId, Integer startRecord, Integer pageSize) throws ServerException
      Sets the pagination informations for the visualization of the folders tree
      Parameters:
      folderId - ID of the folder
      startRecord - Start rec index
      pageSize - Current page size
      Throws:
      ServerException - an error happened in the server application

    • applyGridLayout

      void applyGridLayout(long folderId) throws ServerException
      Replicates the folder's grid layout to all the subtree
      Parameters:
      folderId - identifier of the root folder whose setting will be replicated
      Throws:
      ServerException - error generated in the server application

    • readImage

      String readImage() throws ServerException
      Read the uploaded image and converts it into Base64
      Returns:
      the string conversion of the uploaded image
      Throws:
      ServerException - an error happened in the server application

    • getAllowedPermissions

      GUIAccessControlEntry getAllowedPermissions(List<Long> folderIds) throws ServerException
      Gets the allowed permissions on a set of folders in regards of the current user
      Parameters:
      folderIds - collection of the folders
      Throws:
      ServerException