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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
applyGridLayout
(long folderId) Replicates the folder's grid layout to all the subtreevoid
applyMetadata
(long parentId) Applies all extended attributes to a sub-treevoid
applyOCR
(long parentId) Applies all OCR settings to a sub-treevoid
applyStorage
(long parentId) Applies the storage setting to a sub-treevoid
applyTags
(long parentId) Applies all tags to a sub-treevoid
applyTemplate
(long folderId, long templateId, boolean inheritSecurity) Applies a template to a foldercomputeStats
(long folderId) Counts the docs and subfolders of a given parentvoid
copyFolders
(List<Long> folderIds, long targetId, boolean foldersOnly, String securityOption, GUIFolder model) Copies a folder under a target folderCreates a new foldercreateAlias
(long parentId, long foldRef) Creates a new folder aliasvoid
Deletes the folders and the subtreesvoid
deleteFromTrash
(List<Long> ids) Deletes a selection of folders from trashgetFolder
(long folderId, boolean computePath, boolean computeDocs, boolean computeSubfolders) Gets the Folder initializing the permissions.inheritACL
(long folderId, long rightsFolderId) Inherits the ACL of another folderLoads the folders templatesvoid
Merges some folders to a target foldervoid
Moves some folders under a target foldervoid
paste
(List<Long> docIds, long folderId, String action, boolean links, boolean notes, boolean security) Pastes documents into the target foldervoid
pasteAsAlias
(List<Long> docIds, long folderId, String type) Read the uploaded image and converts it into Base64void
Renames the given foldervoid
Restores a given folderSaves the folder in the DBvoid
Applies all security settings to foldervoid
saveTemplates
(List<GUIValue> templates) Saves the passed folder templatesvoid
setFolderPagination
(long folderId, Integer startRecord, Integer pageSize) Sets the pagination informations for the visualization of the folders tree
-
Method Details
-
save
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
Creates a new folder- Parameters:
newFolder
- The folder to be createdinheritSecurity
- 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
Creates a new folder alias- Parameters:
parentId
- The folder in which the alias must be createdfoldRef
- The original folder- Returns:
- The created alias
- Throws:
ServerException
- an error happened in the server application
-
rename
Renames the given folder- Parameters:
folderId
- identifier of the foldername
- the new folder's name- Throws:
ServerException
- an error happened in the server application
-
saveACL
Applies all security settings to folder- Parameters:
folder
- The folder that contains the new security settingssubfolders
- If true, the current security settings will be applied to the sub-folders- Throws:
ServerException
- an error happened in the server application
-
inheritACL
Inherits the ACL of another folder- Parameters:
folderId
- The folder that has to be updatedrightsFolderId
- the folder that defines the rights- Returns:
- The updated Folder
- Throws:
ServerException
- an error happened in the server application
-
applyMetadata
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
Applies all tags to a sub-tree- Parameters:
parentId
- The parent folder containing the tags- Throws:
ServerException
- an error happened in the server application
-
applyStorage
Applies the storage setting to a sub-tree- Parameters:
parentId
- The parent folder containing the tags- Throws:
ServerException
- an error happened in the server application
-
applyOCR
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 identifiercomputePath
- True if the complete path must be retrievedcomputeDocs
- True if the number of contained documents must be computedcomputeSubfolders
- True if the number of contained subfolders must be computed- Returns:
- The Folder bean
- Throws:
ServerException
- an error happened in the server application
-
delete
Deletes the folders and the subtrees- Parameters:
folderIds
- identifiers of the folders- Throws:
ServerException
- an error happened in the server application
-
deleteFromTrash
Deletes a selection of folders from trash- Parameters:
ids
- identifiers of the folders- Throws:
ServerException
- an error happened in the server application
-
restore
Restores a given folder- Parameters:
folderIds
- identifiers of the folderstargetId
- identifier of the folder that will receive the restore- Throws:
ServerException
- an error happened in the server application
-
move
Moves some folders under a target folder- Parameters:
folderIds
- identifiers of the folderstargetId
- identifier of the folder that will receive the move- Throws:
ServerException
- an error happened in the server application
-
merge
Merges some folders to a target folder- Parameters:
folderIds
- identifiers of the folderstargetId
- 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 folderstargetId
- identifier of the folder that will receive the copyfoldersOnly
- flag to copy just the folders and not the documentssecurityOption
- 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 identifiersfolderId
- the target folder identifieraction
- the selected action(Clipboard.COPY
orClipboard.COPY
)links
- if the links must be copied toonotes
- if the notes and annotations must be copied toosecurity
- if the security settings must be copied too- Throws:
ServerException
- an error happened in the server application
-
pasteAsAlias
- Throws:
ServerException
-
loadTemplates
Loads the folders templates- Returns:
- the folder templates
- Throws:
ServerException
- an error happened in the server application
-
saveTemplates
Saves the passed folder templates- Parameters:
templates
- the folder templates- Throws:
ServerException
- an error happened in the server application
-
applyTemplate
Applies a template to a folder- Parameters:
folderId
- identifier of the folder to use as roottemplateId
- identifier of the template to useinheritSecurity
- if the new folders mus inherit the security fromfolderId
- Throws:
ServerException
- an error happened in the server application
-
computeStats
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 folderstartRecord
- Start rec indexpageSize
- Current page size- Throws:
ServerException
- an error happened in the server application
-
applyGridLayout
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
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
-