public interface FileSystemItemManager
FileSystemItem
given its id. Allows the following
actions:
FileSystemItemManagerImpl
Modifier and Type | Method and Description |
---|---|
boolean |
canMove(String srcId,
String destId,
Principal principal)
Return true if the
FileSystemItem with the given source id can be moved to the FileSystemItem
with the given destination id for the given principal. |
FileItem |
createFile(String parentId,
Blob blob,
Principal principal)
Creates a file with the given blob in the
FileSystemItem with the given id for the given principal. |
FolderItem |
createFolder(String parentId,
String name,
Principal principal)
Creates a folder with the given name in the
FileSystemItem with the given id for the given principal. |
void |
delete(String id,
Principal principal)
Deletes the
FileSystemItem with the given id for the given principal. |
void |
delete(String id,
String parentId,
Principal principal)
Deletes the
FileSystemItem with the given id and parent id for the given principal. |
boolean |
exists(String id,
Principal principal)
Returns true if a
FileSystemItem with the given id exists for the given principal. |
List<FileSystemItem> |
getChildren(String id,
Principal principal)
Gets the children of the
FileSystemItem with the given id for the given principal. |
FileSystemItem |
getFileSystemItemById(String id,
Principal principal)
Gets the
FileSystemItem with the given id for the given principal. |
FileSystemItem |
getFileSystemItemById(String id,
String parentId,
Principal principal)
Gets the
FileSystemItem with the given id and parent id for the given principal. |
CoreSession |
getSession(String repositoryName,
Principal principal)
Deprecated.
since 7.2, use
CoreInstance.openCoreSession(String, Principal) instead. |
List<FileSystemItem> |
getTopLevelChildren(Principal principal)
Deprecated.
use getTopLevelFolder#getChildren instead
|
FolderItem |
getTopLevelFolder(Principal principal)
Gets the top level
FolderItem for the given principal. |
FileSystemItem |
move(String srcId,
String destId,
Principal principal)
Moves the
FileSystemItem with the given source id to the FileSystemItem with the given
destination id for the given principal. |
FileSystemItem |
rename(String id,
String name,
Principal principal)
Renames the
FileSystemItem with the given id with the given name for the given principal. |
FileItem |
updateFile(String id,
Blob blob,
Principal principal)
Updates the
FileSystemItem with the given id with the given blob for the given principal. |
FileItem |
updateFile(String id,
String parentId,
Blob blob,
Principal principal)
Updates the
FileSystemItem with the given id and parent id with the given blob for the given principal. |
@Deprecated CoreSession getSession(String repositoryName, Principal principal) throws ClientException
CoreInstance.openCoreSession(String, Principal)
instead.ClientException
@Deprecated List<FileSystemItem> getTopLevelChildren(Principal principal) throws ClientException
FolderItem
for the given principal.ClientException
- if the top level FolderItem
or its children cannot be retrievedFolderItem getTopLevelFolder(Principal principal) throws ClientException
FolderItem
for the given principal.ClientException
- if the top level FolderItem
cannot be retrievedboolean exists(String id, Principal principal) throws ClientException
FileSystemItem
with the given id exists for the given principal.ClientException
- if no FileSystemItemFactory
can handle the given FileSystemItem
id or if
an error occurs while checking the existenceFileSystemItemFactory.exists(String, Principal)
FileSystemItem getFileSystemItemById(String id, Principal principal) throws ClientException
FileSystemItem
with the given id for the given principal.FileSystemItem
or null if none matches the given idClientException
- if no FileSystemItemFactory
can handle the given FileSystemItem
id or if
an error occurs while retrieving the itemFileSystemItemFactory.getFileSystemItemById(String, Principal)
FileSystemItem getFileSystemItemById(String id, String parentId, Principal principal) throws ClientException
FileSystemItem
with the given id and parent id for the given principal.FileSystemItem
or null if none matches the given id and parent idClientException
- if no FileSystemItemFactory
can handle the given FileSystemItem
ids or if
an error occurs while retrieving the itemgetFileSystemItemById(String, Principal)
List<FileSystemItem> getChildren(String id, Principal principal) throws ClientException
FileSystemItem
with the given id for the given principal.ClientException
- if the FileSystemItem
with the given id cannot be retrieved, or if it is not a
FolderItem
or if an error occurs while retrieving the childrenFolderItem.getChildren()
boolean canMove(String srcId, String destId, Principal principal) throws ClientException
FileSystemItem
with the given source id can be moved to the FileSystemItem
with the given destination id for the given principal.ClientException
- if the FileSystemItem
with the given source or destination id cannot be retrievedFileSystemItem#getCanMove(String)
FolderItem createFolder(String parentId, String name, Principal principal) throws ClientException
FileSystemItem
with the given id for the given principal.ClientException
- if the FileSystemItem
with the given id cannot be retrieved, or if it is not a
FolderItem
or if an error occurs while creating the folderFolderItem.createFolder(String)
FileItem createFile(String parentId, Blob blob, Principal principal) throws ClientException
FileSystemItem
with the given id for the given principal.ClientException
- if the FileSystemItem
with the given id cannot be retrieved, or if it is not a
FolderItem
or if an error occurs while creating the fileFolderItem.createFile(Blob)
FileItem updateFile(String id, Blob blob, Principal principal) throws ClientException
FileSystemItem
with the given id with the given blob for the given principal.ClientException
- if the FileSystemItem
with the given id cannot be retrieved, or if it is not a
FileItem
or if an error occurs while updating the fileFileItem.setBlob(Blob)
FileItem updateFile(String id, String parentId, Blob blob, Principal principal) throws ClientException
FileSystemItem
with the given id and parent id with the given blob for the given principal.ClientException
- if the FileSystemItem
with the given id and parent id cannot be retrieved, or if
it is not a FileItem
or if an error occurs while updating the fileupdateFile(String, Blob, Principal)
void delete(String id, Principal principal) throws ClientException
FileSystemItem
with the given id for the given principal.ClientException
- if the FileSystemItem
with the given id cannot be retrieved or if an error occurs
while deleting the itemFileSystemItem.delete()
void delete(String id, String parentId, Principal principal) throws ClientException
FileSystemItem
with the given id and parent id for the given principal.ClientException
- if the FileSystemItem
with the given id and parent id cannot be retrieved or if
an error occurs while deleting the itemdelete(String, Principal)
FileSystemItem rename(String id, String name, Principal principal) throws ClientException
FileSystemItem
with the given id with the given name for the given principal.ClientException
- if the FileSystemItem
with the given id cannot be retrieved or if an error occurs
while renaming the itemFileSystemItem.rename(String)
FileSystemItem move(String srcId, String destId, Principal principal) throws ClientException
FileSystemItem
with the given source id to the FileSystemItem
with the given
destination id for the given principal.ClientException
- if the FileSystemItem
with the given source or destination id cannot be
retrieved, if the FileSystemItem
with the given destination id is not a folder or if an error
occurs while moving the itemFileSystemItem#move(String)
Copyright © 2015 Nuxeo SA. All rights reserved.