org.nuxeo.drive.service

Interface FileSystemItemAdapterService

All Known Implementing Classes:

FileSystemItemAdapterServiceImpl

public interface FileSystemItemAdapterService

Service for creating the right FileSystemItem adapter depending on the DocumentModel type or facet.

Factories can be contributed to implement a specific behavior for the FileSystemItem adapter creation.

Author:

Antoine Taillefer

See Also:

FileSystemItemAdapterServiceImpl

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getActiveFileSystemItemFactories() Gets the active FileSystemItem factory names.
FileSystemItem	getFileSystemItem(DocumentModel doc) Gets the FileSystemItem for the given DocumentModel.
FileSystemItem	getFileSystemItem(DocumentModel doc, boolean includeDeleted) Gets the FileSystemItem for the given DocumentModel.
FileSystemItem	getFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint) Gets the FileSystemItem for the given DocumentModel.
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem) Gets the FileSystemItem for the given DocumentModel forcing its parent id with the given id.
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted) Gets the FileSystemItem for the given DocumentModel forcing its parent id with the given id.
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint) Gets the FileSystemItem for the given DocumentModel forcing its parent id with the given id.
FileSystemItemFactory	getFileSystemItemFactoryForId(String id) Gets the FileSystemItemFactory that can handle the the given FileSystemItem id.
TopLevelFolderItemFactory	getTopLevelFolderItemFactory() Gets the TopLevelFolderItemFactory.
VirtualFolderItemFactory	getVirtualFolderItemFactory(String factoryName) Gets the VirtualFolderItemFactory for the given factory name.

Method Detail

getFileSystemItem

FileSystemItem getFileSystemItem(DocumentModel doc)
                                 throws ClientException

Gets the 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.

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

Throws:

ClientException

See Also:

FileSystemItemFactory.getFileSystemItem(DocumentModel)

getFileSystemItem

FileSystemItem getFileSystemItem(DocumentModel doc,
                               boolean includeDeleted)
                                 throws ClientException

Gets the 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.

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

Throws:

ClientException

See Also:

FileSystemItemFactory.getFileSystemItem(DocumentModel)

getFileSystemItem

FileSystemItem getFileSystemItem(DocumentModel doc,
                               boolean includeDeleted,
                               boolean relaxSyncRootConstraint)
                                 throws ClientException

Gets the 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.

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

Throws:

ClientException

See Also:

FileSystemItemFactory.getFileSystemItem(DocumentModel)

getFileSystemItem

FileSystemItem getFileSystemItem(DocumentModel doc,
                               FolderItem parentItem)
                                 throws ClientException

Gets the 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.

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

Throws:

ClientException

See Also:

FileSystemItemFactory#getFileSystemItem(DocumentModel, String)

getFileSystemItem

FileSystemItem getFileSystemItem(DocumentModel doc,
                               FolderItem parentItem,
                               boolean includeDeleted)
                                 throws ClientException

Gets the 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.

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

Throws:

ClientException

See Also:

FileSystemItemFactory#getFileSystemItem(DocumentModel, String)

getFileSystemItem

FileSystemItem getFileSystemItem(DocumentModel doc,
                               FolderItem parentItem,
                               boolean includeDeleted,
                               boolean relaxSyncRootConstraint)
                                 throws ClientException

Gets the 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.

If relaxSyncRootConstraint is true no filter is applied on the synchronization root aspect for the current user.

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

Throws:

ClientException

See Also:

FileSystemItemFactory#getFileSystemItem(DocumentModel, String)

getFileSystemItemFactoryForId

FileSystemItemFactory getFileSystemItemFactoryForId(String id)
                                                    throws ClientException

Gets the FileSystemItemFactory that can handle the the given FileSystemItem id.

Throws:

ClientException - if no FileSystemItemFactory can handle the given FileSystemItem id

See Also:

FileSystemItemFactory.canHandleFileSystemItemId(String)

getTopLevelFolderItemFactory

TopLevelFolderItemFactory getTopLevelFolderItemFactory()
                                                       throws ClientException

Gets the TopLevelFolderItemFactory.

Throws:

ClientException

getVirtualFolderItemFactory

VirtualFolderItemFactory getVirtualFolderItemFactory(String factoryName)
                                                     throws ClientException

Gets the VirtualFolderItemFactory for the given factory name.

Throws:

ClientException

getActiveFileSystemItemFactories

Set<String> getActiveFileSystemItemFactories()
                                             throws ClientException

Gets the active FileSystemItem factory names.

Throws:

ClientException