org.nuxeo.drive.service.impl

Class AbstractSyncRootFolderItemFactory

java.lang.Object

org.nuxeo.drive.service.impl.AbstractFileSystemItemFactory

org.nuxeo.drive.service.impl.AbstractSyncRootFolderItemFactory

All Implemented Interfaces:

FileSystemItemFactory

Direct Known Subclasses:

DefaultSyncRootFolderItemFactory, PermissionSyncRootFactory, UserWorkspaceSyncRootFactory

public abstract class AbstractSyncRootFolderItemFactory
extends AbstractFileSystemItemFactory

Base FileSystemItemFactory for a synchronization root FolderItem.

Author:

Antoine Taillefer

Constructor Summary

Constructors

Constructor and Description
AbstractSyncRootFolderItemFactory()

Method Summary

Methods

Modifier and Type	Method and Description
FileSystemItem	getFileSystemItem(DocumentModel doc, boolean includeDeleted) Force parent id using #getParentId(String).
void	handleParameters(Map<String,String> parameters) No parameters by default.
boolean	isFileSystemItem(DocumentModel doc, boolean includeDeleted) The factory considers that a DocumentModel is adaptable as a FileSystemItem if: It is Folderish AND it is not a version nor a proxy AND it is not HiddenInNavigation AND it is not in the "deleted" life cycle state, unless includeDeleted is true AND it is a synchronization root registered for the current user

Methods inherited from class org.nuxeo.drive.service.impl.AbstractFileSystemItemFactory

canHandleFileSystemItemId, exists, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItemById, getName, isFileSystemItem, setName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractSyncRootFolderItemFactory

public AbstractSyncRootFolderItemFactory()

Method Detail

handleParameters

public void handleParameters(Map<String,String> parameters)
                      throws ClientException

No parameters by default.

Specified by:

handleParameters in interface FileSystemItemFactory

Specified by:

handleParameters in class AbstractFileSystemItemFactory

Throws:

ClientException

isFileSystemItem

public boolean isFileSystemItem(DocumentModel doc,
                       boolean includeDeleted)
                         throws ClientException

The factory considers that a DocumentModel is adaptable as a FileSystemItem if:

• It is Folderish
• AND it is not a version nor a proxy
• AND it is not HiddenInNavigation
• AND it is not in the "deleted" life cycle state, unless includeDeleted is true
• AND it is a synchronization root registered for the current user

Specified by:

isFileSystemItem in interface FileSystemItemFactory

Specified by:

isFileSystemItem in class AbstractFileSystemItemFactory

Throws:

ClientException

getFileSystemItem

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

Force parent id using #getParentId(String).

Specified by:

getFileSystemItem in interface FileSystemItemFactory

Overrides:

getFileSystemItem in class AbstractFileSystemItemFactory

Returns:

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

Throws:

ClientException

See Also:

#isFileSystemItem(DocumentModel, boolean))