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

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, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo) Gets the FileSystemItem for the given DocumentModel.
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem) Gets the FileSystemItem for the given DocumentModel forcing its parent with the given parentItem.
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted) Gets the FileSystemItem for the given DocumentModel forcing its parent with the given parentItem.
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint) Gets the FileSystemItem for the given DocumentModel forcing its parent with the given parentItem.
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo) Gets the FileSystemItem for the given DocumentModel forcing its parent with the given parentItem.
FileSystemItemFactory	getFileSystemItemFactoryForId(String id) Gets the FileSystemItemFactory that can handle the the given FileSystemItem id.
Semaphore	getScrollBatchSemaphore() Allows to limit the number of concurrent scrolls run by FolderItem.scrollDescendants(String, int, long).
TopLevelFolderItemFactory	getTopLevelFolderItemFactory() Gets the TopLevelFolderItemFactory.
VirtualFolderItemFactory	getVirtualFolderItemFactory(String factoryName) Gets the VirtualFolderItemFactory for the given factory name.

Method Detail

getFileSystemItem

FileSystemItem getFileSystemItem(DocumentModel doc)

Gets the FileSystemItem for the given DocumentModel. If the document is in the trash 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

See Also:

FileSystemItemFactory.getFileSystemItem(DocumentModel)

getFileSystemItem

FileSystemItem getFileSystemItem(DocumentModel doc,
                                 boolean includeDeleted)

Gets the FileSystemItem for the given DocumentModel. If includeDeleted is true no filter is applied on the "trashed" state, else if the document is in the trash 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

See Also:

FileSystemItemFactory.getFileSystemItem(DocumentModel, boolean)

getFileSystemItem

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

Gets the FileSystemItem for the given DocumentModel.

If includeDeleted is true no filter is applied on the "trashed" state, else if the document is in the trash 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

See Also:

FileSystemItemFactory.getFileSystemItem(DocumentModel, boolean, boolean)

getFileSystemItem

FileSystemItem getFileSystemItem(DocumentModel doc,
                                 boolean includeDeleted,
                                 boolean relaxSyncRootConstraint,
                                 boolean getLockInfo)

Gets the FileSystemItem for the given DocumentModel.

If includeDeleted is true no filter is applied on the "trashed" state, else if the document is in the trash 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.

Returns:

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

Since:

8.3

See Also:

FileSystemItemFactory.getFileSystemItem(DocumentModel, boolean, boolean, boolean)

getFileSystemItem

FileSystemItem getFileSystemItem(DocumentModel doc,
                                 FolderItem parentItem)

Gets the FileSystemItem for the given DocumentModel forcing its parent with the given parentItem. If the document is in the trash 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

See Also:

FileSystemItemFactory.getFileSystemItem(DocumentModel, FolderItem)

getFileSystemItem

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

Gets the FileSystemItem for the given DocumentModel forcing its parent with the given parentItem. If includeDeleted is true no filter is applied on the "trashed" state, else if the document is in the trash 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

See Also:

FileSystemItemFactory.getFileSystemItem(DocumentModel, FolderItem, boolean)

getFileSystemItem

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

Gets the FileSystemItem for the given DocumentModel forcing its parent with the given parentItem.

If includeDeleted is true no filter is applied on the "trashed" state, else if the document is in the trash 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

See Also:

FileSystemItemFactory.getFileSystemItem(DocumentModel, FolderItem, boolean, boolean)

getFileSystemItem

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

Gets the FileSystemItem for the given DocumentModel forcing its parent with the given parentItem.

If includeDeleted is true no filter is applied on the "trashed" state, else if the document is in the trash 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.

Returns:

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

Since:

8.3

See Also:

FileSystemItemFactory.getFileSystemItem(DocumentModel, FolderItem, boolean, boolean, boolean)

getFileSystemItemFactoryForId

FileSystemItemFactory getFileSystemItemFactoryForId(String id)

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

See Also:

FileSystemItemFactory.canHandleFileSystemItemId(String)

getTopLevelFolderItemFactory

TopLevelFolderItemFactory getTopLevelFolderItemFactory()

Gets the TopLevelFolderItemFactory.

getVirtualFolderItemFactory

VirtualFolderItemFactory getVirtualFolderItemFactory(String factoryName)

Gets the VirtualFolderItemFactory for the given factory name.

getActiveFileSystemItemFactories

Set<String> getActiveFileSystemItemFactories()

Gets the active FileSystemItem factory names.

getScrollBatchSemaphore

Semaphore getScrollBatchSemaphore()

Allows to limit the number of concurrent scrolls run by FolderItem.scrollDescendants(String, int, long).

Since:

8.3