FileFolderService (Alfresco 5.0.3 Public API)

org.alfresco.service.cmr.model

Interface FileFolderService

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.

Method Summary
FileInfo	copy(NodeRef sourceNodeRef, NodeRef targetParentRef, String newName) Copy a source file or folder.
FileInfo	create(NodeRef parentNodeRef, String name, QName typeQName) Create a file or folder; or any valid node of type derived from file or folder.
FileInfo	create(NodeRef parentNodeRef, String name, QName typeQName, QName assocQName) Create a file or folder; or any valid node of type derived from file or folder
void	delete(NodeRef nodeRef) Delete a file or folder
boolean	exists(NodeRef nodeRef) Check the validity of a node reference
FileInfo	getFileInfo(NodeRef nodeRef) Get the file info (name, folder, etc) for the given node
NodeRef	getLocalizedSibling(NodeRef nodeRef) Uses the cm:name of the given node and attempts to find a sibling node with a more specific localized name.
List<String>	getNameOnlyPath(NodeRef rootNodeRef, NodeRef nodeRef) Get the file or folder names from the root down to and including the node provided.
List<FileInfo>	getNamePath(NodeRef rootNodeRef, NodeRef nodeRef) Get the file or folder information from the root down to and including the node provided.
ContentReader	getReader(NodeRef nodeRef) Get the reader to the file represented by the node according to the File/Folder model.
FileFolderServiceType	getType(QName typeQName) Checks the type for whether it is a recognised file or folder type or is invalid for the FileFolderService.
ContentWriter	getWriter(NodeRef nodeRef) Get the writer to the file represented by the node according to the File/Folder model.
boolean	isHidden(NodeRef nodeRef) Deprecated. MNT-8704: WebDAV:Content does not disappear after being deleted
List<FileInfo>	list(NodeRef contextNodeRef) Lists immediate child files and folders of the given context node.
PagingResults<FileInfo>	list(NodeRef contextNodeRef, boolean files, boolean folders, Set<QName> ignoreTypeQNames, List<Pair<QName,Boolean>> sortProps, 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 author janv
PagingResults<FileInfo>	list(NodeRef contextNodeRef, boolean files, boolean folders, String pattern, Set<QName> ignoreTypeQNames, List<Pair<QName,Boolean>> sortProps, 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
PagingResults<FileInfo>	list(NodeRef rootNodeRef, Set<QName> searchTypeQNames, Set<QName> ignoreAspectQNames, List<Pair<QName,Boolean>> sortProps, PagingRequest pagingRequest) Lists page of immediate child objects of the given context node with specification of which types to list and optional filtering (exclusion of certain child file/folder subtypes) and sorting
List<FileInfo>	listDeepFolders(NodeRef contextNodeRef, SubFolderFilter filter) Deprecated.
List<FileInfo>	listFiles(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).
List<FileInfo>	listFolders(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(NodeRef sourceNodeRef, NodeRef sourceParentRef, NodeRef targetParentRef, String newName) Deprecated. From 3.4.2, use moveFrom(NodeRef, NodeRef, NodeRef, String) or move(NodeRef, NodeRef, String). See ALF-7692
FileInfo	move(NodeRef sourceNodeRef, NodeRef targetParentRef, String newName) Move a file or folder to a new name and/or location.
FileInfo	moveFrom(NodeRef sourceNodeRef, NodeRef sourceParentRef, NodeRef targetParentRef, String newName) Move a file or folder to a new name and/or location.
FileInfo	rename(NodeRef fileFolderRef, String newName) Rename a file or folder in its current location
FileInfo	resolveNamePath(NodeRef rootNodeRef, List<String> pathElements) Resolve a file or folder name path from a given root node down to the final node.
FileInfo	resolveNamePath(NodeRef rootNodeRef, List<String> pathElements, boolean mustExist) Resolve a file or folder name path from a given root node down to the final node.
List<FileInfo>	search(NodeRef contextNodeRef, 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 "*".
List<FileInfo>	search(NodeRef contextNodeRef, 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 "*".
NodeRef	searchSimple(NodeRef contextNodeRef, String name) Get a node ref of the node that has the name within the parent node
void	setHidden(NodeRef nodeRef, boolean isHidden) Deprecated. MNT-8704: WebDAV:Content does not disappear after being deleted
List<FileInfo>	toFileInfoList(List<NodeRef> nodeRefs) Helper method to transform a list of NodeRef to a list of FileInfo

@Auditable(parameters="contextNodeRef")
List<FileInfo> list(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.

contextNodeRef - the node to start searching in

Returns a list of matching files and folders

@Auditable(parameters={
  "contextNodeRef",
  "files",
  "folders",
  "ignoreTypeQNames",
  "sortProps",
  "pagingRequest"
})
PagingResults<FileInfo> list(NodeRef contextNodeRef,
                             boolean files,
                             boolean folders,
                             Set<QName> ignoreTypeQNames,
                             List<Pair<QName,Boolean>> sortProps,
                             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

author janv

@Auditable(parameters={
  "contextNodeRef",
  "files",
  "folders",
  "ignoreTypeQNames",
  "sortProps",
  "pagingRequest"
})
PagingResults<FileInfo> list(NodeRef contextNodeRef,
                             boolean files,
                             boolean folders,
                             String pattern,
                             Set<QName> ignoreTypeQNames,
                             List<Pair<QName,Boolean>> sortProps,
                             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

@Auditable(parameters="folderNodeRef")
List<FileInfo> listFiles(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.

contextNodeRef - the folder nodeRef to start searching in

Returns a list of matching files

@Auditable(parameters="contextNodeRef")
List<FileInfo> listFolders(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.

contextNodeRef - the node to start searching in

Returns a list of matching folders

@Auditable(parameters="contextNodeRef")
List<FileInfo> listDeepFolders(NodeRef contextNodeRef,
SubFolderFilter filter)

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

contextNodeRef - the node to start searching in

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

@Auditable(parameters="nodeRef")
NodeRef getLocalizedSibling(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.

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

Returns a sibling node or the original node

@Auditable(parameters={
  "contextNodeRef",
  "name"
})
NodeRef searchSimple(NodeRef contextNodeRef,
                     String name)

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

contextNodeRef - the parent node

name - the name of the node to search for

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

@Auditable(parameters={
  "contextNodeRef",
  "namePattern",
  "includeSubFolders"
})
List<FileInfo> search(NodeRef contextNodeRef,
                      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.

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 a list of file or folder matches

@Auditable(parameters={
  "contextNodeRef",
  "namePattern",
  "fileSearch",
  "folderSearch",
  "includeSubFolders"
})
List<FileInfo> search(NodeRef contextNodeRef,
                      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.

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 a list of file or folder matches

@Auditable(parameters={
  "fileFolderRef",
  "newName"
})
FileInfo rename(NodeRef fileFolderRef,
                String newName)
         throws FileExistsException,
                FileNotFoundException

Rename a file or folder in its current location

fileFolderRef - the file or folder to rename

newName - the new name

Return the new file info

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

FileNotFoundException - the file or folder reference doesn't exist

@Auditable(parameters={
  "sourceNodeRef",
  "targetParentRef",
  "newName"
})
FileInfo move(NodeRef sourceNodeRef,
              NodeRef targetParentRef,
              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.

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 the new file info

@Auditable(parameters={
  "sourceNodeRef",
  "sourceParentRef",
  "targetParentRef",
  "newName"
})
FileInfo moveFrom(NodeRef sourceNodeRef,
                  NodeRef sourceParentRef,
                  NodeRef targetParentRef,
                  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.

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 the new file info

@Auditable(parameters={
  "sourceNodeRef",
  "sourceParentRef",
  "targetParentRef",
  "newName"
})
FileInfo move(NodeRef sourceNodeRef,
              NodeRef sourceParentRef,
              NodeRef targetParentRef,
              String newName)
       throws FileExistsException,
              FileNotFoundException

@Auditable(parameters={
  "sourceNodeRef",
  "targetParentRef",
  "newName"
})
FileInfo copy(NodeRef sourceNodeRef,
              NodeRef targetParentRef,
              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.

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.

Return the new file info

@Auditable(parameters={
  "parentNodeRef",
  "name",
  "typeQName"
})
FileInfo create(NodeRef parentNodeRef,
                String name,
                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.

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

name - the name of the node

typeQName - the type to create

Returns the new node's file information

@Auditable(parameters={
  "parentNodeRef",
  "name",
  "typeQName"
})
FileInfo create(NodeRef parentNodeRef,
                String name,
                QName typeQName,
                QName assocQName)
         throws FileExistsException

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

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 the new node's file information

@Auditable(parameters="nodeRef")
void delete(NodeRef nodeRef)

Delete a file or folder

nodeRef - the node to delete

@Auditable(parameters={
  "rootNodeRef",
  "nodeRef"
})
List<FileInfo> getNamePath(NodeRef rootNodeRef,
                           NodeRef nodeRef)
                    throws FileNotFoundException

Get the file or folder information 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.

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 a list of file/folder infos from the root (excluded) down to and including the destination file or folder

FileNotFoundException - if the node could not be found

@Auditable(parameters={
  "rootNodeRef",
  "nodeRef"
})
List<String> getNameOnlyPath(NodeRef rootNodeRef,
                             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.

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 a list of file/folder names from the root (excluded) down to and including the destination file or folder

FileNotFoundException - if the node could not be found

@Auditable(parameters={
  "rootNodeRef",
  "pathElements"
})
FileInfo resolveNamePath(NodeRef rootNodeRef,
                         List<String> pathElements)
                  throws FileNotFoundException

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

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 the info of the file or folder

FileNotFoundException - if no file or folder exists along the path

@Auditable(parameters={
  "rootNodeRef",
  "pathElements",
  "mustExist"
})
FileInfo resolveNamePath(NodeRef rootNodeRef,
                         List<String> pathElements,
                         boolean mustExist)
                  throws FileNotFoundException

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

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 the info of the file or folder or null if mustExist is false and the file does not exist

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

@Auditable(parameters="nodeRef")
FileInfo getFileInfo(NodeRef nodeRef)

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

nodeRef - the node to get info for

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

@Auditable(parameters="nodeRef")
ContentReader getReader(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)

nodeRef - the content node

Returns a handle to the content associated with the node

@Auditable(parameters="nodeRef")
ContentWriter getWriter(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)

nodeRef - the content node

Returns a handle to the content associated with the node

@Auditable(parameters="nodeRef")
boolean exists(NodeRef nodeRef)

Check the validity of a node reference

returns true if the NodeRef is valid

@Auditable(parameters="typeQName")
FileFolderServiceType getType(QName typeQName)

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

typeQName - the type to check

@Deprecated
boolean isHidden(NodeRef nodeRef)

@Deprecated
void setHidden(NodeRef nodeRef,
boolean isHidden)

@Auditable(parameters="rootNodeRef")
PagingResults<FileInfo> list(NodeRef rootNodeRef,
                             Set<QName> searchTypeQNames,
                             Set<QName> ignoreAspectQNames,
                             List<Pair<QName,Boolean>> sortProps,
                             PagingRequest pagingRequest)

Lists page of immediate child objects of the given context node with specification of which types to list and optional filtering (exclusion of certain child file/folder subtypes) and sorting

rootNodeRef - NodeRef

searchTypeQNames - QNames of types to list

ignoreAspectQNames - Set

pagingRequest - PagingRequest

list of node refs, never null

@Auditable(parameters="nodeRefs")
List<FileInfo> toFileInfoList(List<NodeRef> nodeRefs)

Helper method to transform a list of NodeRef to a list of FileInfo

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.