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) throws ClientException
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
ClientException
FileSystemItemFactory.getFileSystemItem(DocumentModel)
FileSystemItem getFileSystemItem(DocumentModel doc, boolean includeDeleted) throws ClientException
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
ClientException
FileSystemItemFactory.getFileSystemItem(DocumentModel)
FileSystemItem getFileSystemItem(DocumentModel doc, FolderItem parentItem) throws ClientException
FileSystemItem
for the given DocumentModel
forcing its parent id with the given id. 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
ClientException
FileSystemItemFactory#getFileSystemItem(DocumentModel, String)
FileSystemItem getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted) throws ClientException
FileSystemItem
for the given DocumentModel
forcing its parent id with the given id. 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
ClientException
FileSystemItemFactory#getFileSystemItem(DocumentModel, String)
FileSystemItemFactory getFileSystemItemFactoryForId(String id) throws ClientException
FileSystemItemFactory
that can handle the the given
FileSystemItem
id.ClientException
- if no FileSystemItemFactory
can handle
the given FileSystemItem
idFileSystemItemFactory.canHandleFileSystemItemId(String)
TopLevelFolderItemFactory getTopLevelFolderItemFactory() throws ClientException
TopLevelFolderItemFactory
.ClientException
VirtualFolderItemFactory getVirtualFolderItemFactory(String factoryName) throws ClientException
VirtualFolderItemFactory
for the given factory name.ClientException
Set<String> getActiveFileSystemItemFactories() throws ClientException
FileSystemItem
factory names.ClientException
Copyright © 2013 Nuxeo SA. All Rights Reserved.