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. |
default FileItem |
createFile(String parentId,
Blob blob,
Principal principal)
Deprecated.
since 9.1, use
createFile(String, Blob, Principal, boolean) instead |
FileItem |
createFile(String parentId,
Blob blob,
Principal principal,
boolean overwrite)
Creates a file with the given blob in the
FileSystemItem with the given id for the given principal. |
default FolderItem |
createFolder(String parentId,
String name,
Principal principal)
Deprecated.
since 9.1, use
createFolder(String, String, Principal, boolean) instead |
FolderItem |
createFolder(String parentId,
String name,
Principal principal,
boolean overwrite)
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. |
ScrollFileSystemItemList |
scrollDescendants(String id,
Principal principal,
String scrollId,
int batchSize,
long keepAlive)
Retrieves at most
batchSize descendants of the FolderItem with the given id for the given
principal and the given scrollId . |
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)
CoreInstance.openCoreSession(String, Principal)
instead.@Deprecated List<FileSystemItem> getTopLevelChildren(Principal principal)
FolderItem
for the given principal.FolderItem getTopLevelFolder(Principal principal)
FolderItem
for the given principal.boolean exists(String id, Principal principal)
FileSystemItem
with the given id exists for the given principal.FileSystemItem getFileSystemItemById(String id, Principal principal)
FileSystemItem
with the given id for the given principal.FileSystemItem
or null if none matches the given idFileSystemItemFactory.getFileSystemItemById(String, Principal)
FileSystemItem getFileSystemItemById(String id, String parentId, Principal principal)
FileSystemItem
with the given id and parent id for the given principal.FileSystemItem
or null if none matches the given id and parent idgetFileSystemItemById(String, Principal)
List<FileSystemItem> getChildren(String id, Principal principal)
FileSystemItem
with the given id for the given principal.FolderItem.getChildren()
ScrollFileSystemItemList scrollDescendants(String id, Principal principal, String scrollId, int batchSize, long keepAlive)
batchSize
descendants of the FolderItem
with the given id
for the given
principal
and the given scrollId
.
When passing a null scrollId
the initial search request is executed and the first batch of results is
returned along with a scrollId
which should be passed to the next call in order to retrieve the next
batch of results.
Ideally, the search context made available by the initial search request is kept alive during keepAlive
milliseconds if keepAlive
is positive.
Results are not necessarily sorted.
FolderItem.scrollDescendants(String, int, long)
boolean canMove(String srcId, String destId, Principal principal)
FileSystemItem
with the given source id can be moved to the FileSystemItem
with the given destination id for the given principal.FileSystemItem#getCanMove(String)
@Deprecated default FolderItem createFolder(String parentId, String name, Principal principal)
createFolder(String, String, Principal, boolean)
insteadFileSystemItem
with the given id for the given principal.FolderItem.createFolder(String)
FolderItem createFolder(String parentId, String name, Principal principal, boolean overwrite)
FileSystemItem
with the given id for the given principal.overwrite
- allows to overwrite an existing folder with the same titleFolderItem.createFolder(String, boolean)
@Deprecated default FileItem createFile(String parentId, Blob blob, Principal principal)
createFile(String, Blob, Principal, boolean)
insteadFileSystemItem
with the given id for the given principal.FolderItem.createFile(Blob)
FileItem createFile(String parentId, Blob blob, Principal principal, boolean overwrite)
FileSystemItem
with the given id for the given principal.overwrite
- allows to overwrite an existing folder with the same titleFolderItem.createFile(Blob, boolean)
FileItem updateFile(String id, Blob blob, Principal principal)
FileSystemItem
with the given id with the given blob for the given principal.FileItem.setBlob(Blob)
FileItem updateFile(String id, String parentId, Blob blob, Principal principal)
FileSystemItem
with the given id and parent id with the given blob for the given principal.updateFile(String, Blob, Principal)
void delete(String id, Principal principal)
FileSystemItem
with the given id for the given principal.FileSystemItem.delete()
void delete(String id, String parentId, Principal principal)
FileSystemItem
with the given id and parent id for the given principal.delete(String, Principal)
FileSystemItem rename(String id, String name, Principal principal)
FileSystemItem
with the given id with the given name for the given principal.FileSystemItem.rename(String)
FileSystemItem move(String srcId, String destId, Principal principal)
FileSystemItem
with the given source id to the FileSystemItem
with the given
destination id for the given principal.FileSystemItem#move(String)
Copyright © 2017 Nuxeo. All rights reserved.