Package com.logicaldoc.core.folder
Interface FolderDAO
- All Superinterfaces:
PersistentObjectDAO<Folder>
- All Known Implementing Classes:
HibernateFolderDAO
Instances of this class is a DAO-service for folder objects.
- Version:
- 6.0
- Author:
- Marco Meschieri - LogicalDOC
-
Field Summary
Fields inherited from interface com.logicaldoc.core.PersistentObjectDAO
ENTITY
-
Method Summary
Modifier and TypeMethodDescriptionvoid
applyGridToTree
(long rootId, FolderHistory transaction) Propagates the grid layout of a node to the whole sub-treevoid
applyMetadataToTree
(long id, FolderHistory transaction) Propagates the template metadata to the whole subreevoid
applyOCRToTree
(long id, FolderHistory transaction) Propagates the OCR settings to the whole subreevoid
applyRightToTree
(long rootId, FolderHistory transaction) Propagates the security policies of a node to the whole sub-treevoid
applyStorageToTree
(long id, FolderHistory transaction) Propagates the storage setting to the whole subreevoid
applyTagsToTree
(long id, FolderHistory transaction) Propagates the tags to the whole subreecomputePath
(long folderId) Dynamically computes the path for the specified folder.computePath
(Folder folder) Dynamically computes the path for the specified folder.computePathExtended
(long folderId) Dynamically computes the path extended for the specified folder.computePathExtended
(Folder folder) Dynamically computes the path extended for the specified folder.long
computeTreeSize
(long rootId) Counts the number of documents inside a given folder's tree (direct and indirect children)copy
(Folder source, Folder target, String newName, boolean foldersOnly, String securityOption, FolderHistory transaction) Copies a folder into another folderint
count
(boolean computeDeleted) Counts the number of folderslong
countDocsInTree
(long rootId) Counts the number of documents inside a given folder's tree (direct and indirect children)create
(Folder parent, Folder folderVO, boolean inheritSecurity, FolderHistory transaction) Creates a new folder in the parent FoldercreateAlias
(long parentId, long foldRef, FolderHistory transaction) Creates a new folder folder aliascreatePath
(Folder parent, String path, boolean inheritSecurity, FolderHistory transaction) Creates the folder for the specified path.void
delete
(long id, int delCode, FolderHistory transaction) This method deletes the folder object and insert a new folder history entryvoid
delete
(long id, FolderHistory transaction) Shortcut for delete(id, 1, transaction)void
deleteAll
(Collection<Folder> folders, int delCode, FolderHistory transaction) For each folder, save the folder delete history entry for each folder and delete the foldervoid
deleteAll
(Collection<Folder> folders, FolderHistory transaction) Shortcut for deleteAll(folders, 1, transaction)deleteTree
(long folderId, int delCode, FolderHistory transaction) Delete a folder and all its sub-folders that a user can delete.deleteTree
(long folderId, FolderHistory transaction) Shortcut for deleteTree(folderId, 1, transaction)deleteTree
(Folder folder, int delCode, FolderHistory transaction) Deletes a folder and all its sub-folders that a user can delete.Useful method that allows to find all folders that contains the given name into their text.findAliases
(Long foldRef, long tenantId) Finds all the aliasesfindByGroupId
(long groupId) Finds all folders accessible by the passed groupfindByName
(Folder parent, String name, Long tenantId, boolean caseSensitive) Finds all folders by folder text, contained in the parent folder.findByName
(String name, Long tenantId) Finds all folders by folder namefindByNameAndParentId
(String name, long parentId) Finds that folder that lies under a specific parent (given by the id) an with a given name(like operator is used)findByParentId
(long parentId) Finds all children(direct and indirect) by parentIdfindByPathExtended
(String pathExtended, long tenantId) Retrieval of a folder by the extended pathfindByUserId
(long userId) Finds authorized folders for a userfindByUserId
(long userId, long parentId) Finds direct children of a folder.findByUserIdAndTag
(long userId, String tag, Integer max) Finds authorized folders for a user having a specified tag.findChildren
(long parentId, long userId) Finds direct children of a folder accessible by the given userfindChildren
(long parentId, Integer max) Finds direct children of a folderfindDefaultWorkspace
(long tenantId) Retrieves the Default workspace of the given tenantfindDeleted
(long userId, Integer maxHits) Finds all deleted folders of a specific user.findFolder
(long folderId) Gets a folder by a given ID if it is an alias, the referenced folder is returned.findFolderIdByUserId
(long userId, Long parentId, boolean tree) This method selects only the folder ID from the folders for which a user is authorized.findFolderIdByUserIdAndPermission
(long userId, Permission permission, Long parentId, boolean tree) Finds all folders ids with a specific permission enabled on the specifies userfindFolderIdByUserIdInPath
(long userId, long parentId) This method selects only the folder ID from the folders for which a user is authorized.findFolderIdInPath
(long rootId, boolean includeDeleted) Retrieve all the ids of the folders in a given tree using the path attributefindFolderIdInTree
(long rootId, boolean includeDeleted) Retrieve all the ids of the folders in a given treefindIdByUserId
(long userId, long parentId) This method selects only the folder ID from the folders for which a user is authorized.findIdsByParentId
(long parentId) Finds all children(direct and indirect) by parentIdfindParents
(long id) Returns a List of folders being a parent of the given folder.findRoot
(long tenantId) Retrieves the root folder of the given tenantfindTags
(long folderId) Retrieves the alphabetically ordered list of all the folder's tagsfindWorkspace
(long folderId) Returns the workspace that contains the given folderfindWorkspaces
(long tanantId) Retrieves all the workspaces in the system, that are the first-level folders of typeFolder.TYPE_WORKSPACE
getEnabledPermissions
(long folderId, long userId) Finds all permissions of a user enabled on the specified folderboolean
hasWriteAccess
(Folder folder, long userId) Checks that the user has access to the folder and all its sub-itemsvoid
initialize
(Folder folder) Initializes lazy loaded collectionsboolean
isDownloadEnabled
(long folderId, long userId) boolean
isInPath
(long parentId, long childId) Checks if a folder with the given folderId is parent of the folder with the given targetIdboolean
isMoveEnabled
(long folderId, long userId) boolean
isPermissionEnabled
(Permission permission, long folderId, long userId) This method checks if the given permission is enabled for a folder and an user.boolean
isPrintEnabled
(long folderId, long userId) boolean
isReadEnabled
(long folderId, long userId) boolean
isWriteEnabled
(long folderId, long userId) This method is looking up for writing rights for a folder and an user.void
merge
(Folder source, Folder target, FolderHistory transaction) Merges the contents of two foldersvoid
move
(Folder source, Folder target, FolderHistory transaction) Moves a folder into another foldervoid
restore
(long folderId, long parentId, FolderHistory transaction) Restores a previously deleted foldervoid
saveFolderHistory
(Folder folder, FolderHistory transaction) Utility method that logs into the DB the transaction that involved the passed folder.void
store
(Folder folder, FolderHistory transaction) Same as store(Folder, boolean, FolderHistory)void
updateSecurityRef
(long folderId, long rightsFolderId, FolderHistory transaction) Changes the securityRef of the given folder, all the other folders that inherits from this one will be changed accordingly.Methods inherited from interface com.logicaldoc.core.PersistentObjectDAO
bulkUpdate, delete, delete, deleteAll, deleteAll, findAll, findAll, findAllIds, findAllIds, findById, findById, findByObjectQuery, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, getDatabaseMetadata, getDbms, isOracle, jdbcUpdate, jdbcUpdate, query, query, queryForInt, queryForList, queryForList, queryForList, queryForLong, queryForLong, queryForObject, queryForRowSet, queryForRowSet, queryForString, store
-
Method Details
-
findFolder
Gets a folder by a given ID if it is an alias, the referenced folder is returned.- Parameters:
folderId
- The ID- Returns:
- A real folder that is referenced by the given ID
- Throws:
PersistenceException
- error at data layer
-
findByName
Finds all folders by folder name- Parameters:
name
- name of the foldertenantId
- Specification of the owning tenant (optional).- Returns:
- List of folders with given folder name.
- Throws:
PersistenceException
- error at data layer
-
findByName
List<Folder> findByName(Folder parent, String name, Long tenantId, boolean caseSensitive) throws PersistenceException Finds all folders by folder text, contained in the parent folder.- Parameters:
parent
- The parent folder(optional)name
- The folder name to search fortenantId
- Specification of the owning tenant (optional). If not specified the tenant of parent is used insteadcaseSensitive
- true if the search must be case sensitive- Returns:
- List of folders with given name
- Throws:
PersistenceException
- error at data layer
-
findRoot
Retrieves the root folder of the given tenant- Parameters:
tenantId
- identifier of the tenant- Returns:
- the root folder
- Throws:
PersistenceException
- error at data layer
-
findDefaultWorkspace
Retrieves the Default workspace of the given tenant- Parameters:
tenantId
- identifier of the tenant- Returns:
- The default workspace
- Throws:
PersistenceException
- error at data layer
-
findByUserId
Finds authorized folders for a user- Parameters:
userId
- ID of the user- Returns:
- List of found folders
- Throws:
PersistenceException
- error at data layer
-
findByUserIdAndTag
Finds authorized folders for a user having a specified tag.- Parameters:
userId
- ID of the usertag
- Tag of the foldermax
- Optional, defines the maximum records number- Returns:
- Collection of found folders
- Throws:
PersistenceException
- error at data layer
-
findFolderIdByUserIdAndPermission
Collection<Long> findFolderIdByUserIdAndPermission(long userId, Permission permission, Long parentId, boolean tree) throws PersistenceException Finds all folders ids with a specific permission enabled on the specifies user- Parameters:
userId
- The user identifierpermission
- The permission to checkparentId
- The id of the parent folder to inspect (optional)tree
- If true, the parentId will be interpreted as the root of a tree- Returns:
- List of selected folder IDs.
- Throws:
PersistenceException
- error at data layer
-
findFolderIdByUserId
Collection<Long> findFolderIdByUserId(long userId, Long parentId, boolean tree) throws PersistenceException This method selects only the folder ID from the folders for which a user is authorized.- Parameters:
userId
- ID of the user.parentId
- The id of the parent folder to inspect (optional)tree
- If true, the parentId will be interpreted as the root of a tree- Returns:
- List of selected folder IDs.
- Throws:
PersistenceException
- error at data layer
-
findFolderIdInTree
Retrieve all the ids of the folders in a given tree- Parameters:
rootId
- Root of the treeincludeDeleted
- True if the deleted records need to be loaded- Returns:
- List of selected folder IDs, rootId is included as well
-
findFolderIdInPath
Collection<Long> findFolderIdInPath(long rootId, boolean includeDeleted) throws PersistenceException Retrieve all the ids of the folders in a given tree using the path attribute- Parameters:
rootId
- Root of the folderincludeDeleted
- True if the deleted records need to be loaded- Returns:
- List of selected folder IDs, rootId is included as well
- Throws:
PersistenceException
- error at data layer
-
findFolderIdByUserIdInPath
This method selects only the folder ID from the folders for which a user is authorized.- Parameters:
userId
- ID of the user.parentId
- The id of the parent folder to inspect- Returns:
- List of selected folder IDs.
- Throws:
PersistenceException
- error at data layer
-
findByUserId
Finds direct children of a folder.- Parameters:
parentId
- ID of the folder which children are wanteduserId
- identifier of the user- Returns:
- List of found folders sorted by text
- Throws:
PersistenceException
- error at data layer
-
findByParentId
Finds all children(direct and indirect) by parentId- Parameters:
parentId
- identifier of the parent folder- Returns:
- List of found folders
-
findIdsByParentId
Finds all children(direct and indirect) by parentId- Parameters:
parentId
- identifier of the parent folder- Returns:
- list of folder IDs
-
findChildren
Finds direct children of a folder- Parameters:
parentId
- Folder ID of the folder which children are wantedmax
- Optional, maximum number of children- Returns:
- List of found folders
- Throws:
PersistenceException
- Error in the database
-
findChildren
Finds direct children of a folder accessible by the given user- Parameters:
parentId
- Folder ID of the folder which children are wanteduserId
- Identifier of the user that must have read access- Returns:
- List of found folders
- Throws:
PersistenceException
- error at data layer
-
isWriteEnabled
This method is looking up for writing rights for a folder and an user.- Parameters:
folderId
- ID of the folderuserId
- ID of the user- Returns:
- if the write permission is granted
- Throws:
PersistenceException
- error at data layer
-
isReadEnabled
- Throws:
PersistenceException
-
isPrintEnabled
- Throws:
PersistenceException
-
isDownloadEnabled
- Throws:
PersistenceException
-
isMoveEnabled
- Throws:
PersistenceException
-
isPermissionEnabled
boolean isPermissionEnabled(Permission permission, long folderId, long userId) throws PersistenceException This method checks if the given permission is enabled for a folder and an user.- Parameters:
permission
- the permission to checkfolderId
- ID of the folderuserId
- ID of the user- Returns:
- if the permission is granted to the user
- Throws:
PersistenceException
- error at data layer
-
getEnabledPermissions
Finds all permissions of a user enabled on the specified folder- Parameters:
folderId
- ID of the folderuserId
- ID of the user- Returns:
- Collection of enabled permissions
- Throws:
PersistenceException
- error at data layer
-
findIdByUserId
This method selects only the folder ID from the folders for which a user is authorized. Only folders direct child of the specified parent are returned.- Parameters:
userId
- ID of the userparentId
- Parent folder- Returns:
- List of selected folder ID's.
- Throws:
PersistenceException
- error at data layer
-
hasWriteAccess
Checks that the user has access to the folder and all its sub-items- Parameters:
folder
- the folderuserId
- identifier of the document- Returns:
- if the user has write permission
- Throws:
PersistenceException
- error at data layer
-
findByGroupId
Finds all folders accessible by the passed group- Parameters:
groupId
- The group id- Returns:
- The List of folders
- Throws:
PersistenceException
- error at data layer
-
findParents
Returns a List of folders being a parent of the given folder. The list is ordered starting from the root of folders. The list doesn't include the given folder.- Parameters:
id
- ID of the folder- Returns:
- the hierarchy of parent folders
- Throws:
PersistenceException
- error at data layer
-
findWorkspace
Returns the workspace that contains the given folder- Parameters:
folderId
- ID of the folder- Returns:
- the workspace containing the given folder
- Throws:
PersistenceException
- error at data layer
-
restore
Restores a previously deleted folder- Parameters:
folderId
- The folder identifierparentId
- The parent folder to restore intransaction
- Current session informations- Throws:
PersistenceException
- error at data layer
-
findByNameAndParentId
Finds that folder that lies under a specific parent (given by the id) an with a given name(like operator is used)- Parameters:
name
- name of the dolderparentId
- identifier of the parent folder- Returns:
- list of folders
- Throws:
PersistenceException
- error at data layer
-
store
Same as store(Folder, boolean, FolderHistory)- Parameters:
folder
- the folder to storetransaction
- current session informations- Throws:
PersistenceException
- error at data layer
-
deleteAll
Shortcut for deleteAll(folders, 1, transaction)- Parameters:
folders
- the folderstransaction
- current session informations- Throws:
PersistenceException
- error at data layer
-
deleteAll
void deleteAll(Collection<Folder> folders, int delCode, FolderHistory transaction) throws PersistenceException For each folder, save the folder delete history entry for each folder and delete the folder- Parameters:
folders
- List of folder to be deletedelCode
- The deletion codetransaction
- entry to log the event on each folder- Throws:
PersistenceException
- error at data layer
-
delete
Shortcut for delete(id, 1, transaction)- Parameters:
id
- the folder identifiertransaction
- the session informations- Throws:
PersistenceException
- error at data layer
-
delete
This method deletes the folder object and insert a new folder history entry- Parameters:
id
- The id of the folder to deletedelCode
- The deletion codetransaction
- entry to log the event- Throws:
PersistenceException
- error at data layer
-
create
Folder create(Folder parent, Folder folderVO, boolean inheritSecurity, FolderHistory transaction) throws PersistenceException Creates a new folder in the parent Folder- Parameters:
parent
- The parent folderfolderVO
- The folder's metadatainheritSecurity
- If true the new folder will 'point' to the parent for the security policies.transaction
- optional transaction entry to log the event- Returns:
- The newly created folder
- Throws:
PersistenceException
- error at data layer
-
createAlias
Folder createAlias(long parentId, long foldRef, FolderHistory transaction) throws PersistenceException Creates a new folder folder alias- Parameters:
parentId
- The parent folderfoldRef
- The referenced foldertransaction
- optional transaction entry to log the event- Returns:
- The newly created alias
- Throws:
PersistenceException
- error at data layer
-
findAliases
Finds all the aliases- Parameters:
foldRef
- The referenced foldertenantId
- The tenant- Returns:
- Collection of aliases
-
createPath
Folder createPath(Folder parent, String path, boolean inheritSecurity, FolderHistory transaction) throws PersistenceException Creates the folder for the specified path. All unexisting nodes specified in the path will be created. The path must be in any case inside a workspace, if not, the Default one will be used.- Parameters:
parent
- The parent folderpath
- The folder path(for example /dog/cat/mouse)inheritSecurity
- If true the new folders will 'point' to the parent for the security policies.transaction
- optional transaction entry to log the event- Returns:
- The created folder
- Throws:
PersistenceException
- error at data layer
-
computePath
Dynamically computes the path for the specified folder. The path is a sequence of IDS in the form: /4/55897/99870- Parameters:
folderId
- identifier of the folder- Returns:
- the folder's path
- Throws:
PersistenceException
- error at data layer
-
computePath
Dynamically computes the path for the specified folder. The path is a sequence of IDS in the form: /4/55897/99870- Parameters:
folder
- the folder to process- Returns:
- the folder's path
- Throws:
PersistenceException
- error at data layer
-
computePathExtended
Dynamically computes the path extended for the specified folder. The path extended is a human readable path in the form: /folder1/folder2/folder3- Parameters:
folder
- the folder to process- Returns:
- The path extended
- Throws:
PersistenceException
- error at data layer
-
computePathExtended
Dynamically computes the path extended for the specified folder. The path extended is a human readable path in the form: /folder1/folder2/folder3- Parameters:
folderId
- the folder's identifier- Returns:
- The path extended
- Throws:
PersistenceException
- error at data layer
-
findByPathExtended
Retrieval of a folder by the extended path- Parameters:
pathExtended
- the path extendedtenantId
- identifier of the tenant- Returns:
- The folder that matched the given path
- Throws:
PersistenceException
- error at data layer
-
move
Moves a folder into another folder- Parameters:
source
- The folder to movetarget
- The target foldertransaction
- entry to log the event (set the user)- Throws:
PersistenceException
- error at data layer
-
copy
Folder copy(Folder source, Folder target, String newName, boolean foldersOnly, String securityOption, FolderHistory transaction) throws PersistenceException Copies a folder into another folder- Parameters:
source
- The folder to copytarget
- The target foldernewName
- optional new name of the copied folderfoldersOnly
- True if only the folders tree has to be copied; if false, the documents will also be copiedsecurityOption
- How to assign the security policies to the newly created folders:- null or none: empty security policies
- inherit: the new folder will point to the parent for the security policies
- replicate: the new folder will have a copy of the security policies of the source folder
transaction
- entry to log the event (set the user)- Returns:
- The new folder created
- Throws:
PersistenceException
- error at data layer
-
deleteTree
List<Folder> deleteTree(Folder folder, int delCode, FolderHistory transaction) throws PersistenceException Deletes a folder and all its sub-folders that a user can delete. After recovering of all sub-folders inside the folder, will be canceled all folders for which the user has the delete permission or there isn't an immutable document inside it.
Important: Remember to delete orphaned documents.- Parameters:
folder
- Folder to deletedelCode
- The deletion codetransaction
- entry to log the event (set the user)- Returns:
- List of folders that the user cannot delete(permissions, o immutable documents presents)
- Throws:
PersistenceException
- error at data layer
-
deleteTree
List<Folder> deleteTree(long folderId, int delCode, FolderHistory transaction) throws PersistenceException Delete a folder and all its sub-folders that a user can delete. After recovering of all sub-folders inside the folder, will be canceled all folders for which the user has the delete permission or there isn't an immutable document inside it.
Important: All the contained documents will be deleted- Parameters:
folderId
- Folder to deletedelCode
- The deletion codetransaction
- entry to log the event (set the user)- Returns:
- List of folders that the user cannot delete(permissions, o immutable documents presents)
- Throws:
PersistenceException
- error at data layer
-
deleteTree
Shortcut for deleteTree(folderId, 1, transaction)- Parameters:
folderId
- Folder to deletetransaction
- entry to log the event (set the user)- Returns:
- List of folders that the user cannot delete(permissions, o immutable documents presents)
- Throws:
PersistenceException
- error at data layer
-
find
Useful method that allows to find all folders that contains the given name into their text.- Parameters:
name
- The name to be foundtenantId
- The tenant to search in- Returns:
- List of folders that contains the given name into their text.
- Throws:
PersistenceException
- error at data layer
-
findDeleted
Finds all deleted folders of a specific user.- Parameters:
userId
- The user that performed the deletionmaxHits
- Optional defines the max number of returned hits- Returns:
- The folders list
-
isInPath
Checks if a folder with the given folderId is parent of the folder with the given targetId- Parameters:
parentId
- The folder to be checkedchildId
- The target folder- Returns:
- True if the folder with the given parentId is parent of the folder with the given childId
- Throws:
PersistenceException
- error at data layer
-
applyRightToTree
Propagates the security policies of a node to the whole sub-tree- Parameters:
rootId
- identifier of the root foldertransaction
- session informations- Throws:
PersistenceException
- error at data layer
-
applyGridToTree
Propagates the grid layout of a node to the whole sub-tree- Parameters:
rootId
- identifier of the root foldertransaction
- session informations- Throws:
PersistenceException
- error at data layer
-
updateSecurityRef
void updateSecurityRef(long folderId, long rightsFolderId, FolderHistory transaction) throws PersistenceException Changes the securityRef of the given folder, all the other folders that inherits from this one will be changed accordingly.- Parameters:
folderId
- identifier of the folderrightsFolderId
- id of the folder to inherit fromtransaction
- session informations- Throws:
PersistenceException
- error at data layer
-
applyMetadataToTree
Propagates the template metadata to the whole subree- Parameters:
id
- identifier of the foldertransaction
- session informations- Throws:
PersistenceException
- error at data layer
-
applyTagsToTree
Propagates the tags to the whole subree- Parameters:
id
- identifier of the foldertransaction
- session informations- Throws:
PersistenceException
- error at data layer
-
applyStorageToTree
Propagates the storage setting to the whole subree- Parameters:
id
- identifier of the foldertransaction
- session informations- Throws:
PersistenceException
- error at data layer
-
applyOCRToTree
Propagates the OCR settings to the whole subree- Parameters:
id
- identifier of the foldertransaction
- session informations- Throws:
PersistenceException
- error at data layer
-
count
int count(boolean computeDeleted) Counts the number of folders- Parameters:
computeDeleted
- if the deleted folders have to be taken int account- Returns:
- the number of folders
-
findWorkspaces
Retrieves all the workspaces in the system, that are the first-level folders of typeFolder.TYPE_WORKSPACE
- Parameters:
tanantId
- identifier of the tenant- Returns:
- list of folders
- Throws:
PersistenceException
- error at data layer
-
initialize
Initializes lazy loaded collections- Specified by:
initialize
in interfacePersistentObjectDAO<Folder>
- Parameters:
folder
- The folder to be initialized
-
saveFolderHistory
Utility method that logs into the DB the transaction that involved the passed folder. The transaction must be provided with userId and userName.- Parameters:
folder
- the foldertransaction
- the session informations- Throws:
PersistenceException
- error at data layer
-
countDocsInTree
long countDocsInTree(long rootId) Counts the number of documents inside a given folder's tree (direct and indirect children)- Parameters:
rootId
- identifier of the root folder- Returns:
- the number of documents contained in the tree
-
computeTreeSize
long computeTreeSize(long rootId) Counts the number of documents inside a given folder's tree (direct and indirect children)- Parameters:
rootId
- identifier of the root folder- Returns:
- sum of the sizes of the documents contained in the tree expressed in bytes
-
findTags
Retrieves the alphabetically ordered list of all the folder's tags- Parameters:
folderId
- identifier of the folder- Returns:
- list of tags
-
merge
Merges the contents of two folders- Parameters:
source
- The folder whose contents must be merged inside folderAtarget
- The main folder to use as containertransaction
- the session informations- Throws:
PersistenceException
- in case of database or logical error
-