public interface FileSystemItemAdapterService
FileSystemItem
adapter depending on the DocumentModel
type or facet.
Factories can be contributed to implement a specific behavior for the FileSystemItem
adapter creation.
FileSystemItemAdapterServiceImpl
FileSystemItem getFileSystemItem(DocumentModel doc)
FileSystemItem
for the given DocumentModel
. If the document is in the "deleted" life
cycle state it is not considered as adaptable as a FileSystemItem
, thus the method returns null.FileSystemItem
or null if the DocumentModel
is not adaptable as a
FileSystemItem
FileSystemItemFactory.getFileSystemItem(DocumentModel)
FileSystemItem getFileSystemItem(DocumentModel doc, boolean includeDeleted)
FileSystemItem
for the given DocumentModel
. If includeDeleted
is true no filter
is applied on the "deleted" life cycle state, else if the document is in this state it is not considered as
adaptable as a FileSystemItem
, thus the method returns null.FileSystemItem
or null if the DocumentModel
is not adaptable as a
FileSystemItem
FileSystemItemFactory.getFileSystemItem(DocumentModel, boolean)
FileSystemItem getFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint)
FileSystemItem
for the given DocumentModel
.
If includeDeleted
is true no filter is applied on the "deleted" life cycle state, else if the document is
in this state it is not considered as adaptable as a FileSystemItem
, thus the method returns null.
If relaxSyncRootConstraint
is true no filter is applied on the synchronization root aspect for the
current user.
FileSystemItem
or null if the DocumentModel
is not adaptable as a
FileSystemItem
FileSystemItemFactory.getFileSystemItem(DocumentModel, boolean, boolean)
FileSystemItem getFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo)
FileSystemItem
for the given DocumentModel
.
If includeDeleted
is true no filter is applied on the "deleted" life cycle state, else if the document is
in this state it is not considered as adaptable as a FileSystemItem
, thus the method returns null.
If relaxSyncRootConstraint
is true no filter is applied on the synchronization root aspect for the
current user.
If getLockInfo
is true the Lock
is fetched from the DocumentModel
and set on the returned
FileSystemItem
.
FileSystemItem
or null if the DocumentModel
is not adaptable as a
FileSystemItem
FileSystemItemFactory.getFileSystemItem(DocumentModel, boolean, boolean, boolean)
FileSystemItem getFileSystemItem(DocumentModel doc, FolderItem parentItem)
FileSystemItem
for the given DocumentModel
forcing its parent with the given
parentItem
. If the document is in the "deleted" life cycle state it is not considered as adaptable as a
FileSystemItem
, thus the method returns null.FileSystemItem
or null if the DocumentModel
is not adaptable as a
FileSystemItem
FileSystemItemFactory.getFileSystemItem(DocumentModel, FolderItem)
FileSystemItem getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted)
FileSystemItem
for the given DocumentModel
forcing its parent with the given
parentItem
. If includeDeleted
is true no filter is applied on the "deleted" life cycle state,
else if the document is in this state it is not considered as adaptable as a FileSystemItem
, thus the
method returns null.FileSystemItem
or null if the DocumentModel
is not adaptable as a
FileSystemItem
FileSystemItemFactory.getFileSystemItem(DocumentModel, FolderItem, boolean)
FileSystemItem getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint)
FileSystemItem
for the given DocumentModel
forcing its parent with the given
parentItem
.
If includeDeleted
is true no filter is applied on the "deleted" life cycle state, else if the document is
in this state it is not considered as adaptable as a FileSystemItem
, thus the method returns null.
If relaxSyncRootConstraint
is true no filter is applied on the synchronization root aspect for the
current user.
FileSystemItem
or null if the DocumentModel
is not adaptable as a
FileSystemItem
FileSystemItemFactory.getFileSystemItem(DocumentModel, FolderItem, boolean, boolean)
FileSystemItem getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo)
FileSystemItem
for the given DocumentModel
forcing its parent with the given
parentItem
.
If includeDeleted
is true no filter is applied on the "deleted" life cycle state, else if the document is
in this state it is not considered as adaptable as a FileSystemItem
, thus the method returns null.
If relaxSyncRootConstraint
is true no filter is applied on the synchronization root aspect for the
current user.
If getLockInfo
is true the Lock
is fetched from the DocumentModel
and set on the returned
FileSystemItem
.
FileSystemItem
or null if the DocumentModel
is not adaptable as a
FileSystemItem
FileSystemItemFactory.getFileSystemItem(DocumentModel, FolderItem, boolean, boolean, boolean)
FileSystemItemFactory getFileSystemItemFactoryForId(String id)
FileSystemItemFactory
that can handle the the given FileSystemItem
id.TopLevelFolderItemFactory getTopLevelFolderItemFactory()
TopLevelFolderItemFactory
.VirtualFolderItemFactory getVirtualFolderItemFactory(String factoryName)
VirtualFolderItemFactory
for the given factory name.Set<String> getActiveFileSystemItemFactories()
FileSystemItem
factory names.Semaphore getScrollBatchSemaphore()
FolderItem.scrollDescendants(String, int, long)
.Copyright © 2018 Nuxeo. All rights reserved.