org.alfresco.service.cmr.model

Interface FileFolderService

All Known Implementing Classes:

FileFolderServiceImpl

public interface FileFolderService

Provides methods specific to manipulating files and folders. So this interface provides a simple way of accessing simple trees of files and folders in Alfresco.

See Also:

ContentModel

Method Summary

Methods

Modifier and Type	Method and Description
FileInfo	copy(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, org.alfresco.service.cmr.repository.NodeRef targetParentRef, java.lang.String newName) Copy a source file or folder.
FileInfo	create(org.alfresco.service.cmr.repository.NodeRef parentNodeRef, java.lang.String name, org.alfresco.service.namespace.QName typeQName) Create a file or folder; or any valid node of type derived from file or folder.
FileInfo	create(org.alfresco.service.cmr.repository.NodeRef parentNodeRef, java.lang.String name, org.alfresco.service.namespace.QName typeQName, org.alfresco.service.namespace.QName assocQName) Create a file or folder; or any valid node of type derived from file or folder
void	delete(org.alfresco.service.cmr.repository.NodeRef nodeRef) Delete a file or folder
boolean	exists(org.alfresco.service.cmr.repository.NodeRef nodeRef) Check the validity of a node reference
FileInfo	getFileInfo(org.alfresco.service.cmr.repository.NodeRef nodeRef) Get the file info (name, folder, etc) for the given node
org.alfresco.service.cmr.repository.NodeRef	getLocalizedSibling(org.alfresco.service.cmr.repository.NodeRef nodeRef) Uses the cm:name of the given node and attempts to find a sibling node with a more specific localized name.
java.util.List	getNamePath(org.alfresco.service.cmr.repository.NodeRef rootNodeRef, org.alfresco.service.cmr.repository.NodeRef nodeRef) Get the file or folder names from the root down to and including the node provided.
org.alfresco.service.cmr.repository.ContentReader	getReader(org.alfresco.service.cmr.repository.NodeRef nodeRef) Get the reader to the file represented by the node according to the File/Folder model.
FileFolderServiceType	getType(org.alfresco.service.namespace.QName typeQName) Checks the type for whether it is a recognised file or folder type or is invalid for the FileFolderService.
org.alfresco.service.cmr.repository.ContentWriter	getWriter(org.alfresco.service.cmr.repository.NodeRef nodeRef) Get the writer to the file represented by the node according to the File/Folder model.
java.util.List	list(org.alfresco.service.cmr.repository.NodeRef contextNodeRef) Lists immediate child files and folders of the given context node.
org.alfresco.query.PagingResults	list(org.alfresco.service.cmr.repository.NodeRef contextNodeRef, boolean files, boolean folders, java.util.Set ignoreTypeQNames, java.util.List sortProps, org.alfresco.query.PagingRequest pagingRequest) Lists page of immediate child files and/or folders of the given context node with optional filtering (exclusion of certain child file/folder subtypes) and sorting
org.alfresco.query.PagingResults	list(org.alfresco.service.cmr.repository.NodeRef contextNodeRef, boolean files, boolean folders, java.lang.String pattern, java.util.Set ignoreTypeQNames, java.util.List sortProps, org.alfresco.query.PagingRequest pagingRequest) Lists page of immediate child files and/or folders of the given context node with pattern matching and optional filtering (exclusion of certain child file/folder subtypes) and sorting Pattern uses '*' as a wildcard
java.util.List	listDeepFolders(org.alfresco.service.cmr.repository.NodeRef contextNodeRef, SubFolderFilter filter) Deprecated.
java.util.List	listFiles(org.alfresco.service.cmr.repository.NodeRef contextNodeRef) Lists all immediate child files of the given context node Note: this could be a long list (and will be trimmed at a pre-configured maximum).
java.util.List	listFolders(org.alfresco.service.cmr.repository.NodeRef contextNodeRef) Lists all immediate child folders of the given context node Note: this could be a long list (and will be trimmed at a pre-configured maximum).
FileInfo	move(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, org.alfresco.service.cmr.repository.NodeRef sourceParentRef, org.alfresco.service.cmr.repository.NodeRef targetParentRef, java.lang.String newName) Deprecated. From 3.4.2, use FileFolderService.moveFrom(NodeRef, NodeRef, NodeRef, String) or FileFolderService.move(NodeRef, NodeRef, String). See ALF-7692
FileInfo	move(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, org.alfresco.service.cmr.repository.NodeRef targetParentRef, java.lang.String newName) Move a file or folder to a new name and/or location.
FileInfo	moveFrom(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, org.alfresco.service.cmr.repository.NodeRef sourceParentRef, org.alfresco.service.cmr.repository.NodeRef targetParentRef, java.lang.String newName) Move a file or folder to a new name and/or location.
FileInfo	rename(org.alfresco.service.cmr.repository.NodeRef fileFolderRef, java.lang.String newName) Rename a file or folder in its current location
FileInfo	resolveNamePath(org.alfresco.service.cmr.repository.NodeRef rootNodeRef, java.util.List pathElements) Resolve a file or folder name path from a given root node down to the final node.
FileInfo	resolveNamePath(org.alfresco.service.cmr.repository.NodeRef rootNodeRef, java.util.List pathElements, boolean mustExist) Resolve a file or folder name path from a given root node down to the final node.
java.util.List	search(org.alfresco.service.cmr.repository.NodeRef contextNodeRef, java.lang.String namePattern, boolean includeSubFolders) Deprecated. for shallow search use list, listFolders, listFiles, searchSimple. For deep listing use listDeepFolders. Avoid calling this method with any name pattern except for "*".
java.util.List	search(org.alfresco.service.cmr.repository.NodeRef contextNodeRef, java.lang.String namePattern, boolean fileSearch, boolean folderSearch, boolean includeSubFolders) Deprecated. for shallow search use list, listFolders, listFiles, searchSimple. For deep listing use listDeepFolders. Avoid calling this method with any name pattern except for "*".
org.alfresco.service.cmr.repository.NodeRef	searchSimple(org.alfresco.service.cmr.repository.NodeRef contextNodeRef, java.lang.String name) Get a node ref of the node that has the name within the parent node

Method Detail

list

@Auditable(parameters="contextNodeRef")
java.util.List list(org.alfresco.service.cmr.repository.NodeRef contextNodeRef)

Lists immediate child files and folders of the given context node.

Note: this could be a long list (and will be trimmed at a pre-configured maximum). You should consider using a paging request.

Parameters:

contextNodeRef - the node to start searching in

Returns:

Returns a list of matching files and folders

list

@Auditable(parameters={"contextNodeRef", "files", "folders", "ignoreTypeQNames", "sortProps", "pagingRequest"})
org.alfresco.query.PagingResults list(org.alfresco.service.cmr.repository.NodeRef contextNodeRef,
                                              boolean files,
                                              boolean folders,
                                              java.util.Set ignoreTypeQNames,
                                              java.util.List sortProps,
                                              org.alfresco.query.PagingRequest pagingRequest)

Lists page of immediate child files and/or folders of the given context node with optional filtering (exclusion of certain child file/folder subtypes) and sorting

Since:

4.0

list

@Auditable(parameters={"contextNodeRef", "files", "folders", "ignoreTypeQNames", "sortProps", "pagingRequest"})
org.alfresco.query.PagingResults list(org.alfresco.service.cmr.repository.NodeRef contextNodeRef,
                                              boolean files,
                                              boolean folders,
                                              java.lang.String pattern,
                                              java.util.Set ignoreTypeQNames,
                                              java.util.List sortProps,
                                              org.alfresco.query.PagingRequest pagingRequest)

Lists page of immediate child files and/or folders of the given context node with pattern matching and optional filtering (exclusion of certain child file/folder subtypes) and sorting Pattern uses '*' as a wildcard

Since:

4.0

listFiles

@Auditable(parameters="folderNodeRef")
java.util.List listFiles(org.alfresco.service.cmr.repository.NodeRef contextNodeRef)

Lists all immediate child files of the given context node Note: this could be a long list (and will be trimmed at a pre-configured maximum). You should consider using a paging request.

Parameters:

folderNodeRef - the folder to start searching in

Returns:

Returns a list of matching files

listFolders

@Auditable(parameters="contextNodeRef")
java.util.List listFolders(org.alfresco.service.cmr.repository.NodeRef contextNodeRef)

Lists all immediate child folders of the given context node Note: this could be a long list (and will be trimmed at a pre-configured maximum). You should consider using a paging request.

Parameters:

contextNodeRef - the node to start searching in

Returns:

Returns a list of matching folders

listDeepFolders

@Auditable(parameters="contextNodeRef")
java.util.List listDeepFolders(org.alfresco.service.cmr.repository.NodeRef contextNodeRef,
                                       SubFolderFilter filter)

Deprecated.

Lists all folders below the given context node, both immediate and lower levels The filter parameter allows subfolders to be excluded from the search.

Parameters:

contextNodeRef - the node to start searching in

filter - - may be null in which case all sub-folders will be searched

getLocalizedSibling

@Auditable(parameters="nodeRef")
org.alfresco.service.cmr.repository.NodeRef getLocalizedSibling(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Uses the cm:name of the given node and attempts to find a sibling node with a more specific localized name. The node passed in must represent the base of the possible translations i.e. the base name for the resource names will be calculated using the filename without extension. The locale used will come from the thread's default locale.

Parameters:

nodeRef - the node that acts as the baseline for the search

Returns:

Returns a sibling node or the original node

searchSimple

@Auditable(parameters={"contextNodeRef", "name"})
org.alfresco.service.cmr.repository.NodeRef searchSimple(org.alfresco.service.cmr.repository.NodeRef contextNodeRef,
                                                                 java.lang.String name)

Get a node ref of the node that has the name within the parent node

Parameters:

contextNodeRef - the parent node

name - the name of the node to search for

Returns:

Returns the node that has the given name - or null if not found

search

@Auditable(parameters={"contextNodeRef", "namePattern", "includeSubFolders"})
java.util.List search(org.alfresco.service.cmr.repository.NodeRef contextNodeRef,
                              java.lang.String namePattern,
                              boolean includeSubFolders)

Deprecated. for shallow search use list, listFolders, listFiles, searchSimple. For deep listing use listDeepFolders. Avoid calling this method with any name pattern except for "*".

Searches for all files and folders with the matching name pattern, using wildcard characters * and ?. Warning: Please avoid using this method with any "namePattern" other than "*". Although it works, its performance is poor, which is why this method is deprecated.

Parameters:

contextNodeRef - the context of the search. This node will never be returned as part of the search results.

namePattern - the name of the file or folder to search for, or a wildcard pattern to search for.

includeSubFolders - true to search the entire hierarchy below the search context

Returns:

Returns a list of file or folder matches

See Also:

FileFolderService.search(NodeRef, String, boolean, boolean, boolean)

search

@Auditable(parameters={"contextNodeRef", "namePattern", "fileSearch", "folderSearch", "includeSubFolders"})
java.util.List search(org.alfresco.service.cmr.repository.NodeRef contextNodeRef,
                              java.lang.String namePattern,
                              boolean fileSearch,
                              boolean folderSearch,
                              boolean includeSubFolders)

Deprecated. for shallow search use list, listFolders, listFiles, searchSimple. For deep listing use listDeepFolders. Avoid calling this method with any name pattern except for "*".

Perform a search against the name of the files or folders within a hierarchy. Wildcard characters are * and ?. Warning: Please avoid using this method with any "namePattern" other than "*". Although it works, its performance is poor which is why this method is deprecated.

Parameters:

contextNodeRef - the context of the search. This node will never be returned as part of the search results.

namePattern - the name of the file or folder to search for, or a wildcard pattern to search for.

fileSearch - true if file types are to be included in the search results

folderSearch - true if folder types are to be included in the search results

includeSubFolders - true to search the entire hierarchy below the search context

Returns:

Returns a list of file or folder matches

rename

@Auditable(parameters={"fileFolderRef", "newName"})
FileInfo rename(org.alfresco.service.cmr.repository.NodeRef fileFolderRef,
                        java.lang.String newName)
                throws FileExistsException,
                       FileNotFoundException

Rename a file or folder in its current location

Parameters:

fileFolderRef - the file or folder to rename

newName - the new name

Returns:

Return the new file info

Throws:

FileExistsException - if a file or folder with the new name already exists

FileNotFoundException - the file or folder reference doesn't exist

move

@Auditable(parameters={"sourceNodeRef", "targetParentRef", "newName"})
FileInfo move(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
                      org.alfresco.service.cmr.repository.NodeRef targetParentRef,
                      java.lang.String newName)
              throws FileExistsException,
                     FileNotFoundException

Move a file or folder to a new name and/or location.

If both the parent folder and name remain the same, then nothing is done.

Parameters:

sourceNodeRef - the file or folder to move

targetParentRef - the new parent node to move the node to - null means rename in situ

newName - the name to change the file or folder to - null to keep the existing name

Returns:

Returns the new file info

Throws:

FileExistsException

FileNotFoundException

moveFrom

@Auditable(parameters={"sourceNodeRef", "sourceParentRef", "targetParentRef", "newName"})
FileInfo moveFrom(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
                          org.alfresco.service.cmr.repository.NodeRef sourceParentRef,
                          org.alfresco.service.cmr.repository.NodeRef targetParentRef,
                          java.lang.String newName)
                  throws FileExistsException,
                         FileNotFoundException

Move a file or folder to a new name and/or location.

If both the parent folder and name remain the same, then nothing is done.

It is possible to specify which is the parent node when moving nodes; nodes can reside in multiple locations.

Parameters:

sourceNodeRef - the file or folder to move

sourceParentRef - the source parent of node - null means move from primary parent

targetParentRef - the new parent node to move the node to - null means rename in situ

newName - the name to change the file or folder to - null to keep the existing name

Returns:

Returns the new file info

Throws:

FileExistsException

FileNotFoundException

move

@Auditable(parameters={"sourceNodeRef", "sourceParentRef", "targetParentRef", "newName"})
FileInfo move(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
                      org.alfresco.service.cmr.repository.NodeRef sourceParentRef,
                      org.alfresco.service.cmr.repository.NodeRef targetParentRef,
                      java.lang.String newName)
              throws FileExistsException,
                     FileNotFoundException

Deprecated. From 3.4.2, use FileFolderService.moveFrom(NodeRef, NodeRef, NodeRef, String) or FileFolderService.move(NodeRef, NodeRef, String). See ALF-7692

Throws:

FileExistsException

FileNotFoundException

copy

@Auditable(parameters={"sourceNodeRef", "targetParentRef", "newName"})
FileInfo copy(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
                      org.alfresco.service.cmr.repository.NodeRef targetParentRef,
                      java.lang.String newName)
              throws FileExistsException,
                     FileNotFoundException

Copy a source file or folder. The source can be optionally renamed and optionally moved into another folder.

If both the parent folder and name remain the same, then nothing is done.

Parameters:

sourceNodeRef - the file or folder to copy

targetParentRef - the new parent node to copy the node to - null means rename in situ

newName - the new name, or null to keep the existing name.

Returns:

Return the new file info

Throws:

FileExistsException

FileNotFoundException

create

@Auditable(parameters={"parentNodeRef", "name", "typeQName"})
FileInfo create(org.alfresco.service.cmr.repository.NodeRef parentNodeRef,
                        java.lang.String name,
                        org.alfresco.service.namespace.QName typeQName)
                throws FileExistsException

Create a file or folder; or any valid node of type derived from file or folder.

The association QName for the patch defaults to cm:filename i.e. the Content Model namespace with the filename as the local name.

Parameters:

parentNodeRef - the parent node. The parent must be a valid folder.

name - the name of the node

typeQName - the type to create

Returns:

Returns the new node's file information

Throws:

FileExistsException

See Also:

#create(NodeRef, String, QName, QName)}

create

@Auditable(parameters={"parentNodeRef", "name", "typeQName"})
FileInfo create(org.alfresco.service.cmr.repository.NodeRef parentNodeRef,
                        java.lang.String name,
                        org.alfresco.service.namespace.QName typeQName,
                        org.alfresco.service.namespace.QName assocQName)
                throws FileExistsException

Create a file or folder; or any valid node of type derived from file or folder

Parameters:

parentNodeRef - the parent node. The parent must be a valid folder.

name - the name of the node

typeQName - the type to create

assocQName - the association QName to set for the path (may be null).

Returns:

Returns the new node's file information

Throws:

FileExistsException

delete

@Auditable(parameters="nodeRef")
void delete(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Delete a file or folder

Parameters:

nodeRef - the node to delete

getNamePath

@Auditable(parameters={"rootNodeRef", "nodeRef"})
java.util.List getNamePath(org.alfresco.service.cmr.repository.NodeRef rootNodeRef,
                                   org.alfresco.service.cmr.repository.NodeRef nodeRef)
                           throws FileNotFoundException

Get the file or folder names from the root down to and including the node provided.

• The root node can be of any type and is not included in the path list.
• Only the primary path is considered. If the target node is not a descendant of the root along purely primary associations, then an exception is generated.
• If an invalid type is encountered along the path, then an exception is generated.

Parameters:

rootNodeRef - the start of the returned path, or null if the store root node must be assumed.

nodeRef - a reference to the file or folder

Returns:

Returns a list of file/folder infos from the root (excluded) down to and including the destination file or folder

Throws:

FileNotFoundException - if the node could not be found

resolveNamePath

@Auditable(parameters={"rootNodeRef", "pathElements"})
FileInfo resolveNamePath(org.alfresco.service.cmr.repository.NodeRef rootNodeRef,
                                 java.util.List pathElements)
                         throws FileNotFoundException

Resolve a file or folder name path from a given root node down to the final node.

Parameters:

rootNodeRef - the start point node - a cm:folder type or subtype, e.g. the Company Home's nodeRef

pathElements - a list of names in the path. Do not include the referenced rootNodeRef's path element.

Returns:

Returns the info of the file or folder

Throws:

FileNotFoundException - if no file or folder exists along the path

resolveNamePath

@Auditable(parameters={"rootNodeRef", "pathElements", "mustExist"})
FileInfo resolveNamePath(org.alfresco.service.cmr.repository.NodeRef rootNodeRef,
                                 java.util.List pathElements,
                                 boolean mustExist)
                         throws FileNotFoundException

Resolve a file or folder name path from a given root node down to the final node.

Parameters:

rootNodeRef - the start point node - a cm:folder type or subtype, e.g. the Company Home's nodeRef

pathElements - a list of names in the path. Do not include the referenced rootNodeRef's path element.

Returns:

Returns the info of the file or folder or null if mustExist is false and the file does not exist

Throws:

FileNotFoundException - if no file or folder exists along the path and mustExist is true

getFileInfo

@Auditable(parameters="nodeRef")
FileInfo getFileInfo(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Get the file info (name, folder, etc) for the given node

Parameters:

nodeRef - the node to get info for

Returns:

Returns the file info or null if the node does not represent a file or folder

getReader

@Auditable(parameters="nodeRef")
org.alfresco.service.cmr.repository.ContentReader getReader(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Get the reader to the file represented by the node according to the File/Folder model. (This is not the same as the method on the ContentService)

Parameters:

nodeRef - the content node

Returns:

Returns a handle to the content associated with the node

getWriter

@Auditable(parameters="nodeRef")
org.alfresco.service.cmr.repository.ContentWriter getWriter(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Get the writer to the file represented by the node according to the File/Folder model. (This is not the same as the method on the ContentService)

Parameters:

nodeRef - the content node

Returns:

Returns a handle to the content associated with the node

exists

@Auditable(parameters="nodeRef")
boolean exists(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Check the validity of a node reference

Returns:

returns true if the NodeRef is valid

getType

@Auditable(parameters="typeQName")
FileFolderServiceType getType(org.alfresco.service.namespace.QName typeQName)

Checks the type for whether it is a recognised file or folder type or is invalid for the FileFolderService.

Parameters:

typeQName - the type to check

Returns:

- the type