Package com.logicaldoc.web.service
Class FolderServiceImpl
java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet
com.google.gwt.user.server.rpc.RemoteServiceServlet
com.logicaldoc.web.service.AbstractRemoteService
com.logicaldoc.web.service.FolderServiceImpl
- All Implemented Interfaces:
com.google.gwt.user.client.rpc.RemoteService
,com.google.gwt.user.server.rpc.SerializationPolicyProvider
,FolderService
,Serializable
,javax.servlet.Servlet
,javax.servlet.ServletConfig
Implementation of the FolderService
- Since:
- 6.0
- Author:
- Matteo Caruso - LogicalDOC
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.logicaldoc.gui.frontend.client.services.FolderService
FolderService.Instance
-
Constructor 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 trashfromFolder
(Folder folder, boolean computePath) getFolder
(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 treeMethods inherited from class com.google.gwt.user.server.rpc.RemoteServiceServlet
getSerializationPolicy, init, processCall, processCall, processPost
Methods inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet
doPost
Methods inherited from class javax.servlet.http.HttpServlet
service
Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log
-
Constructor Details
-
FolderServiceImpl
public FolderServiceImpl()
-
-
Method Details
-
inheritACL
Description copied from interface:FolderService
Inherits the ACL of another folder- Specified by:
inheritACL
in interfaceFolderService
- 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
-
saveACL
Description copied from interface:FolderService
Applies all security settings to folder- Specified by:
saveACL
in interfaceFolderService
- Parameters:
guiFolder
- The folder that contains the new security settingssubtree
- If true, the current security settings will be applied to the sub-folders- Throws:
ServerException
- an error happened in the server application
-
applyMetadata
Description copied from interface:FolderService
Applies all extended attributes to a sub-tree- Specified by:
applyMetadata
in interfaceFolderService
- Parameters:
parentId
- The parent folder containing the metadata- Throws:
ServerException
- an error happened in the server application
-
delete
Description copied from interface:FolderService
Deletes the folders and the subtrees- Specified by:
delete
in interfaceFolderService
- Parameters:
folderIds
- identifiers of the folders- Throws:
ServerException
- an error happened in the server application
-
fromFolder
- Throws:
PersistenceException
-
computeStats
Description copied from interface:FolderService
Counts the docs and subfolders of a given parent- Specified by:
computeStats
in interfaceFolderService
- 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
-
getFolder
- Throws:
ServerException
-
getFolder
public GUIFolder getFolder(Session session, long folderId, boolean computePath) throws ServerException - Throws:
ServerException
-
getFolder
public GUIFolder getFolder(long folderId, boolean computePath, boolean computeDocs, boolean computeSubfolders) throws ServerException Description copied from interface:FolderService
Gets the Folder initializing the permissions.- Specified by:
getFolder
in interfaceFolderService
- 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
-
copyFolders
public void copyFolders(List<Long> folderIds, long targetId, boolean foldersOnly, String securityOption, GUIFolder model) throws ServerException Description copied from interface:FolderService
Copies a folder under a target folder- Specified by:
copyFolders
in interfaceFolderService
- 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
-
move
Description copied from interface:FolderService
Moves some folders under a target folder- Specified by:
move
in interfaceFolderService
- Parameters:
folderIds
- identifiers of the folderstargetId
- identifier of the folder that will receive the move- Throws:
ServerException
- an error happened in the server application
-
rename
Description copied from interface:FolderService
Renames the given folder- Specified by:
rename
in interfaceFolderService
- Parameters:
folderId
- identifier of the foldername
- the new folder's name- Throws:
ServerException
- an error happened in the server application
-
save
Description copied from interface:FolderService
Saves the folder in the DB- Specified by:
save
in interfaceFolderService
- Parameters:
guiFolder
- The folder to save- Returns:
- The saved folder
- Throws:
ServerException
- an error happened in the server application
-
create
Description copied from interface:FolderService
Creates a new folder- Specified by:
create
in interfaceFolderService
- 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
Description copied from interface:FolderService
Creates a new folder alias- Specified by:
createAlias
in interfaceFolderService
- 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
-
paste
public void paste(List<Long> docIds, long folderId, String action, boolean links, boolean notes, boolean security) throws ServerException Description copied from interface:FolderService
Pastes documents into the target folder- Specified by:
paste
in interfaceFolderService
- 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
- Specified by:
pasteAsAlias
in interfaceFolderService
- Throws:
ServerException
-
loadTemplates
Description copied from interface:FolderService
Loads the folders templates- Specified by:
loadTemplates
in interfaceFolderService
- Returns:
- the folder templates
- Throws:
ServerException
- an error happened in the server application
-
saveTemplates
Description copied from interface:FolderService
Saves the passed folder templates- Specified by:
saveTemplates
in interfaceFolderService
- Parameters:
templates
- the folder templates- Throws:
ServerException
- an error happened in the server application
-
applyTemplate
public void applyTemplate(long folderId, long templateId, boolean inheritSecurity) throws ServerException Description copied from interface:FolderService
Applies a template to a folder- Specified by:
applyTemplate
in interfaceFolderService
- 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
-
restore
Description copied from interface:FolderService
Restores a given folder- Specified by:
restore
in interfaceFolderService
- Parameters:
folderIds
- identifiers of the foldersparentId
- identifier of the folder that will receive the restore- Throws:
ServerException
- an error happened in the server application
-
deleteFromTrash
Description copied from interface:FolderService
Deletes a selection of folders from trash- Specified by:
deleteFromTrash
in interfaceFolderService
- Parameters:
ids
- identifiers of the folders- Throws:
ServerException
- an error happened in the server application
-
applyTags
Description copied from interface:FolderService
Applies all tags to a sub-tree- Specified by:
applyTags
in interfaceFolderService
- Parameters:
parentId
- The parent folder containing the tags- Throws:
ServerException
- an error happened in the server application
-
setFolderPagination
public void setFolderPagination(long folderId, Integer startRecord, Integer pageSize) throws ServerException Description copied from interface:FolderService
Sets the pagination informations for the visualization of the folders tree- Specified by:
setFolderPagination
in interfaceFolderService
- Parameters:
folderId
- ID of the folderstartRecord
- Start rec indexpageSize
- Current page size- Throws:
ServerException
- an error happened in the server application
-
applyGridLayout
Description copied from interface:FolderService
Replicates the folder's grid layout to all the subtree- Specified by:
applyGridLayout
in interfaceFolderService
- Parameters:
folderId
- identifier of the root folder whose setting will be replicated- Throws:
ServerException
- error generated in the server application
-
applyOCR
Description copied from interface:FolderService
Applies all OCR settings to a sub-tree- Specified by:
applyOCR
in interfaceFolderService
- Parameters:
parentId
- The parent folder containing the settings- Throws:
ServerException
- an error happened in the server application
-
applyStorage
Description copied from interface:FolderService
Applies the storage setting to a sub-tree- Specified by:
applyStorage
in interfaceFolderService
- Parameters:
parentId
- The parent folder containing the tags- Throws:
ServerException
- an error happened in the server application
-
merge
Description copied from interface:FolderService
Merges some folders to a target folder- Specified by:
merge
in interfaceFolderService
- Parameters:
folderIds
- identifiers of the folderstargetId
- identifier of the folder that will receive the merge- Throws:
ServerException
- an error happened in the server application
-
readImage
Description copied from interface:FolderService
Read the uploaded image and converts it into Base64- Specified by:
readImage
in interfaceFolderService
- Returns:
- the string conversion of the uploaded image
- Throws:
ServerException
- an error happened in the server application
-