|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
FolderHandler
Method Summary | |
Folder |
getFolder(String path)
getFolder |
Folder |
getFolder(String path,
boolean fromCache)
getFolder |
NodeSet |
getFolders(String path)
getFolders |
NodeSet |
getNodes(String path,
boolean regexp,
String documentType)
getNodes |
String[] |
list(String folderPath,
String documentType)
list |
String[] |
listAll(String folderPath)
|
void |
removeFolder(Folder folder)
removeFolder |
void |
updateFolder(Folder folder)
updateFolder |
Method Detail |
public Folder getFolder(String path) throws FolderNotFoundException, InvalidFolderException, NodeException
getFolder
Locates a folder given using the path
argument. This should behave
as getFolder("folder/subfolder, true);
path
- fully-quallified path to a folder
path
argument. Never returns null
DocumentException
- if there was an error processing the request.
InvalidFolderException
NodeException
DocumentNotFoundException
- If there is no folder at the path
specified.
FolderNotFoundException
public void updateFolder(Folder folder) throws FailedToUpdateFolderException
updateFolder
Updates the folder specified with the folder
argument.
folder
- folder to update
FailedToUpdateFolderException
public void removeFolder(Folder folder) throws FailedToDeleteFolderException
removeFolder
Removes the folder specified with the folder
argument.
folder
- folder to update
FailedToDeleteFolderException
public Folder getFolder(String path, boolean fromCache) throws FolderNotFoundException, InvalidFolderException, NodeException
getFolder
Locates a folder given using the path
argument.
path
- fully-quallified path to a folderfromCache
- whether or not to check the cache first before checking the underlying folder
repository.
path
argument. Never returns null
DocumentException
- if there was an error processing the request.
InvalidFolderException
NodeException
DocumentNotFoundException
- If there is no folder at the path
specified.
FolderNotFoundException
public NodeSet getFolders(String path) throws FolderNotFoundException, InvalidFolderException, NodeException
getFolders
path
- Path from which to locate child folders
path
argument.
FolderNotFoundException
- if folder under the path
does not actually
exist
DocumentException
- if an error is encountered reading the folders.
InvalidFolderException
NodeException
public String[] list(String folderPath, String documentType) throws FolderNotFoundException
list
generates a list of document names, relative to the folderPath
argument
of the type indicated by the documentType
argument.
folderPath
- folder path to search underdocumentType
- document type to filter on.
String[]
of child document names relative to the folderPath
argument and matching the documentType
argument.
FolderNotFoundException
- if the folderPath
does not exsit.public String[] listAll(String folderPath) throws FolderNotFoundException
FolderNotFoundException
public NodeSet getNodes(String path, boolean regexp, String documentType) throws FolderNotFoundException, InvalidFolderException, NodeException
getNodes
Returns a set of nodes relative to the folder
argument of the type
indicated by the documentType
argument. The folder
argument
may include regular expressions if indicated by the regex
argument. The
returned set is unordered.
path
- Path from which to locate documentsregexp
- Flag indicating whether regexp should be expanded in pathdocumentType
- document type to filter on.
path
argument.
FolderNotFoundException
- if folder under the path
does not actually exist.
DocumentException
- if an error is encountered reading the folders.
InvalidFolderException
NodeException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |