# Uses of Class
com.logicaldoc.core.folder.Folder

Packages that use Folder
Package
Description
com.logicaldoc.core.automation
Automation subsystem that allows you to program your own logic inside the platform.
The automation engine can be accessed through the class `Automation`
Please note the special annotation `AutomationDictionary` that is used to automatically put in the Dictionary whatever bean you need.
com.logicaldoc.core.communication
Classes that model emails and messages and the machinery to work with them.
com.logicaldoc.core.document
Contains the definitions of `Document` and `Version` as well as other related objects
com.logicaldoc.core.folder
Contains the definitions of `Folder` as well as other related objects
com.logicaldoc.core.transfer

## Uses of Folder in com.logicaldoc.core.automation

Methods in com.logicaldoc.core.automation that return Folder
Modifier and Type
Method
Description
`Folder`
FolderTool.`copy(Folder source, String targetPath, boolean foldersOnly, String securityOption, String username)`
Copies a folder into another folder
`Folder`
DocTool.`createPath(Document doc, String targetPath, String username)`
Creates a path, all existing nodes in the specified path will be reused
`Folder`
FolderTool.`createPath(Folder folder, String targetPath, String username)`
Creates a path, all existing nodes in the specified path will be reused
`Folder`
FolderTool.`findById(long id)`
Finds the folder by it's identifier
`Folder`
FolderTool.`findByPath(String path)`
Finds the folder by it's path
`Folder`
FolderTool.`findByPath(String path, Long tenantId)`
Finds the folder by it's path
Methods in com.logicaldoc.core.automation with parameters of type Folder
Modifier and Type
Method
Description
`Folder`
FolderTool.`copy(Folder source, String targetPath, boolean foldersOnly, String securityOption, String username)`
Copies a folder into another folder
`Document`
DocTool.`createAlias(Document originalDoc, Folder targetFolder, String type, String username)`
Creates an alias to a document
`Folder`
FolderTool.`createPath(Folder folder, String targetPath, String username)`
Creates a path, all existing nodes in the specified path will be reused
`String`
FolderTool.`displayUrl(Folder folder)`
Prints the URL to display the folder inside the User Interface
`void`
FolderTool.`initialize(Folder folder)`
Initializes lazy loaded collections
`void`
FolderTool.`merge(Folder source, Folder target, String username)`
Merges a folder into another folder
`void`
FolderTool.`move(Folder folder, String targetPath, String username)`
Moves a folder into a target folder
`void`
FolderTool.`store(Folder folder)`
Saves / updates a folder into the database
`void`
FolderTool.`store(Folder folder, String username)`
Saves / updates a folder into the database

## Uses of Folder in com.logicaldoc.core.communication

Methods in com.logicaldoc.core.communication that return Folder
Modifier and Type
Method
Description
`Folder`
EMail.`getTargetFolder()`
Methods in com.logicaldoc.core.communication with parameters of type Folder
Modifier and Type
Method
Description
`void`
EMail.`setTargetFolder(Folder targetFolder)`

## Uses of Folder in com.logicaldoc.core.document

Methods in com.logicaldoc.core.document that return Folder
Modifier and Type
Method
Description
`Folder`
AbstractDocumentHistory.`getFolder()`
`Folder`
Document.`getFolder()`
Retrieve the folder owning this document
`Folder`
DocumentDAO.`getWorkspace(long docId)`
Retrieves, the workspace where the document(or alias) is stored
`Folder`
HibernateDocumentDAO.`getWorkspace(long docId)`
Methods in com.logicaldoc.core.document with parameters of type Folder
Modifier and Type
Method
Description
`DocumentFuture`
DocumentManager.`copyToFolder(Document doc, Folder folder, DocumentHistory transaction, boolean links, boolean notes, boolean security)`
Copy a document to the specified folder.
`Document`
DocumentManager.`createAlias(Document doc, Folder folder, String aliasType, DocumentHistory transaction)`
Create an alias(shortcut) associated to the given doc to the specified folder.
`DocumentFuture`
DocumentManager.`moveToFolder(Document doc, Folder folder, DocumentHistory transaction)`
Moves a document to the specified folder.
`void`
AbstractDocumentHistory.`setFolder(Folder folder)`
`void`
Document.`setFolder(Folder folder)`
Constructors in com.logicaldoc.core.document with parameters of type Folder
Modifier
Constructor
Description
``
`TooManyDocumentsException(Folder folder, long max)`

## Uses of Folder in com.logicaldoc.core.folder

Methods in com.logicaldoc.core.folder that return Folder
Modifier and Type
Method
Description
`Folder`
FolderDAO.`copy(Folder source, Folder target, String newName, boolean foldersOnly, String securityOption, FolderHistory transaction)`
Copies a folder into another folder
`Folder`
HibernateFolderDAO.`copy(Folder source, Folder target, String newName, boolean foldersOnly, String securityOption, FolderHistory transaction)`
`Folder`
FolderDAO.`create(Folder parent, Folder folderVO, boolean inheritSecurity, FolderHistory transaction)`
Creates a new folder in the parent Folder
`Folder`
HibernateFolderDAO.`create(Folder parent, Folder folderVO, boolean inheritSecurity, FolderHistory transaction)`
`Folder`
FolderDAO.`createAlias(long parentId, long foldRef, FolderHistory transaction)`
Creates a new folder folder alias
`Folder`
HibernateFolderDAO.`createAlias(long parentId, long foldRef, FolderHistory transaction)`
`Folder`
FolderDAO.`createPath(Folder parent, String path, boolean inheritSecurity, FolderHistory transaction)`
Creates the folder for the specified path.
`Folder`
HibernateFolderDAO.`createPath(Folder parent, String path, boolean inheritSecurity, FolderHistory transaction)`
`Folder`
FolderDAO.`findByPathExtended(String pathExtended, long tenantId)`
Retrieval of a folder by the extended path
`Folder`
HibernateFolderDAO.`findByPathExtended(String pathExtended, long tenantId)`
`Folder`
FolderDAO.`findDefaultWorkspace(long tenantId)`
Retrieves the Default workspace of the given tenant
`Folder`
HibernateFolderDAO.`findDefaultWorkspace(long tenantId)`
`Folder`
FolderDAO.`findFolder(long folderId)`
Gets a folder by a given ID if it is an alias, the referenced folder is returned.
`Folder`
HibernateFolderDAO.`findFolder(long folderId)`
`Folder`
FolderDAO.`findRoot(long tenantId)`
Retrieves the root folder of the given tenant
`Folder`
HibernateFolderDAO.`findRoot(long tenantId)`
`Folder`
FolderDAO.`findWorkspace(long folderId)`
Returns the workspace that contains the given folder
`Folder`
HibernateFolderDAO.`findWorkspace(long folderId)`
Methods in com.logicaldoc.core.folder that return types with arguments of type Folder
Modifier and Type
Method
Description
`List<Folder>`
FolderDAO.`deleteTree(long folderId, int delCode, FolderHistory transaction)`
Delete a folder and all its sub-folders that a user can delete.
`List<Folder>`
FolderDAO.`deleteTree(long folderId, FolderHistory transaction)`
Shortcut for deleteTree(folderId, 1, transaction)
`List<Folder>`
FolderDAO.`deleteTree(Folder folder, int delCode, FolderHistory transaction)`
Deletes a folder and all its sub-folders that a user can delete.
`List<Folder>`
HibernateFolderDAO.`deleteTree(long folderId, int delCode, FolderHistory transaction)`
`List<Folder>`
HibernateFolderDAO.`deleteTree(long folderId, FolderHistory transaction)`
`List<Folder>`
HibernateFolderDAO.`deleteTree(Folder folder, int delCode, FolderHistory transaction)`
`List<Folder>`
FolderDAO.`find(String name, Long tenantId)`
Useful method that allows to find all folders that contains the given name into their text.
`List<Folder>`
HibernateFolderDAO.`find(String name, Long tenantId)`
`List<Folder>`
FolderDAO.`findAliases(Long foldRef, long tenantId)`
Finds all the aliases
`List<Folder>`
HibernateFolderDAO.`findAliases(Long foldRef, long tenantId)`
`List<Folder>`
FolderDAO.`findByGroupId(long groupId)`
Finds all folders accessible by the passed group
`List<Folder>`
HibernateFolderDAO.`findByGroupId(long groupId)`
`List<Folder>`
FolderDAO.`findByName(Folder parent, String name, Long tenantId, boolean caseSensitive)`
Finds all folders by folder text, contained in the parent folder.
`List<Folder>`
FolderDAO.`findByName(String name, Long tenantId)`
Finds all folders by folder name
`List<Folder>`
HibernateFolderDAO.`findByName(Folder parent, String name, Long tenantId, boolean caseSensitive)`
`List<Folder>`
HibernateFolderDAO.`findByName(String name, Long tenantId)`
`List<Folder>`
FolderDAO.`findByNameAndParentId(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)
`List<Folder>`
HibernateFolderDAO.`findByNameAndParentId(String name, long parentId)`
`List<Folder>`
FolderDAO.`findByParentId(long parentId)`
Finds all children(direct and indirect) by parentId
`List<Folder>`
HibernateFolderDAO.`findByParentId(long parentId)`
`List<Folder>`
FolderDAO.`findByUserId(long userId)`
Finds authorized folders for a user
`List<Folder>`
FolderDAO.`findByUserId(long userId, long parentId)`
Finds direct children of a folder.
`List<Folder>`
HibernateFolderDAO.`findByUserId(long userId)`
`List<Folder>`
HibernateFolderDAO.`findByUserId(long userId, long parentId)`
`List<Folder>`
FolderDAO.`findByUserIdAndTag(long userId, String tag, Integer max)`
Finds authorized folders for a user having a specified tag.
`List<Folder>`
HibernateFolderDAO.`findByUserIdAndTag(long userId, String tag, Integer max)`
`List<Folder>`
FolderDAO.`findChildren(long parentId, long userId)`
Finds direct children of a folder accessible by the given user
`List<Folder>`
FolderDAO.`findChildren(long parentId, Integer max)`
Finds direct children of a folder
`List<Folder>`
HibernateFolderDAO.`findChildren(long parentId, long userId)`
`List<Folder>`
HibernateFolderDAO.`findChildren(long parentId, Integer max)`
`List<Folder>`
FolderDAO.`findDeleted(long userId, Integer maxHits)`
Finds all deleted folders of a specific user.
`List<Folder>`
HibernateFolderDAO.`findDeleted(long userId, Integer maxHits)`
`List<Folder>`
FolderDAO.`findParents(long id)`
Returns a List of folders being a parent of the given folder.
`List<Folder>`
HibernateFolderDAO.`findParents(long folderId)`
`List<Folder>`
FolderDAO.`findWorkspaces(long tanantId)`
Retrieves all the workspaces in the system, that are the first-level folders of type `TYPE_WORKSPACE`
`List<Folder>`
HibernateFolderDAO.`findWorkspaces(long tenantId)`
`static Comparator<Folder>`
FolderComparator.`getComparator(String sort)`
Methods in com.logicaldoc.core.folder with parameters of type Folder
Modifier and Type
Method
Description
`void`
FolderInitializer.`afterStore(Folder document, FolderHistory transaction, Map<String,Object> dictionary)`
`void`
FolderListener.`afterStore(Folder folder, FolderHistory transaction, Map<String,Object> dictionary)`
Called after a folder is stored in the database
`void`
FolderValidator.`afterStore(Folder folder, FolderHistory transaction, Map<String,Object> dictionary)`
`void`
FolderInitializer.`beforeStore(Folder folder, FolderHistory transaction, Map<String,Object> dictionary)`
`void`
FolderListener.`beforeStore(Folder folder, FolderHistory transaction, Map<String,Object> dictionary)`
Called before a folder is stored in the database
`void`
FolderValidator.`beforeStore(Folder folder, FolderHistory transaction, Map<String,Object> dictionary)`
`int`
Folder.`compareTo(Folder other)`
`String`
FolderDAO.`computePath(Folder folder)`
Dynamically computes the path for the specified folder.
`String`
HibernateFolderDAO.`computePath(Folder folder)`
`String`
FolderDAO.`computePathExtended(Folder folder)`
Dynamically computes the path extended for the specified folder.
`String`
HibernateFolderDAO.`computePathExtended(Folder folder)`
`Folder`
FolderDAO.`copy(Folder source, Folder target, String newName, boolean foldersOnly, String securityOption, FolderHistory transaction)`
Copies a folder into another folder
`Folder`
HibernateFolderDAO.`copy(Folder source, Folder target, String newName, boolean foldersOnly, String securityOption, FolderHistory transaction)`
`Folder`
FolderDAO.`create(Folder parent, Folder folderVO, boolean inheritSecurity, FolderHistory transaction)`
Creates a new folder in the parent Folder
`Folder`
HibernateFolderDAO.`create(Folder parent, Folder folderVO, boolean inheritSecurity, FolderHistory transaction)`
`Folder`
FolderDAO.`createPath(Folder parent, String path, boolean inheritSecurity, FolderHistory transaction)`
Creates the folder for the specified path.
`Folder`
HibernateFolderDAO.`createPath(Folder parent, String path, boolean inheritSecurity, FolderHistory transaction)`
`List<Folder>`
FolderDAO.`deleteTree(Folder folder, int delCode, FolderHistory transaction)`
Deletes a folder and all its sub-folders that a user can delete.
`List<Folder>`
HibernateFolderDAO.`deleteTree(Folder folder, int delCode, FolderHistory transaction)`
`List<Folder>`
FolderDAO.`findByName(Folder parent, String name, Long tenantId, boolean caseSensitive)`
Finds all folders by folder text, contained in the parent folder.
`List<Folder>`
HibernateFolderDAO.`findByName(Folder parent, String name, Long tenantId, boolean caseSensitive)`
`boolean`
FolderDAO.`hasWriteAccess(Folder folder, long userId)`
Checks that the user has write access to the folder and all its sub-items
`boolean`
HibernateFolderDAO.`hasWriteAccess(Folder folder, long userId)`
`void`
FolderDAO.`initialize(Folder folder)`
Initializes lazy loaded collections
`void`
HibernateFolderDAO.`initialize(Folder folder)`
`void`
FolderDAO.`merge(Folder source, Folder target, FolderHistory transaction)`
Merges the contents of two folders
`void`
HibernateFolderDAO.`merge(Folder source, Folder target, FolderHistory transaction)`
`void`
FolderDAO.`move(Folder source, Folder target, FolderHistory transaction)`
Moves a folder into another folder
`void`
HibernateFolderDAO.`move(Folder source, Folder target, FolderHistory transaction)`
`void`
FolderDAO.`saveFolderHistory(Folder folder, FolderHistory transaction)`
Utility method that logs into the DB the transaction that involved the passed folder.
`void`
HibernateFolderDAO.`saveFolderHistory(Folder folder, FolderHistory transaction)`
Utility method that logs into the DB the transaction that involved the passed folder.
`void`
FolderDAO.`store(Folder folder, FolderHistory transaction)`
Same as store(Folder, boolean, FolderHistory)
`void`
HibernateFolderDAO.`store(Folder folder)`
`void`
HibernateFolderDAO.`store(Folder folder, FolderHistory transaction)`
Method parameters in com.logicaldoc.core.folder with type arguments of type Folder
Modifier and Type
Method
Description
`void`
FolderDAO.`deleteAll(Collection<Folder> folders, int delCode, FolderHistory transaction)`
For each folder, save the folder delete history entry for each folder and delete the folder
`void`
FolderDAO.`deleteAll(Collection<Folder> folders, FolderHistory transaction)`
Shortcut for deleteAll(folders, 1, transaction)
`void`
HibernateFolderDAO.`deleteAll(Collection<Folder> folders, int code, FolderHistory transaction)`
`void`
HibernateFolderDAO.`deleteAll(Collection<Folder> folders, FolderHistory transaction)`
Constructors in com.logicaldoc.core.folder with parameters of type Folder
Modifier
Constructor
Description
``
`Folder(Folder source)`

## Uses of Folder in com.logicaldoc.core.transfer

Methods in com.logicaldoc.core.transfer with parameters of type Folder
Modifier and Type
Method
Description
`void`
InMemoryZipImport.`process(File zipsource, Folder parent, long userId, String sessionId)`
`void`
ZipImport.`process(File zipsource, Folder parent, long userId, String sessionId)`
`void`
ZipImport.`process(String zipsource, Folder parent, long userId, String sessionId)`