Class AbstractVirtualFolderItemFactory
- All Implemented Interfaces:
FileSystemItemFactory
,VirtualFolderItemFactory
- Direct Known Subclasses:
DefaultTopLevelFolderItemFactory
,PermissionTopLevelFactory
,SharedSyncRootParentFactory
,UserWorkspaceSyncRootParentFactory
FileSystemItemFactory
for a virtual FolderItem
.- Author:
- Antoine Taillefer
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns true if the givenFileSystemItem
id can be handled by this factory.boolean
exists
(String id, NuxeoPrincipal principal) Returns true if aFileSystemItem
with the given id exists for the given principal.Gets theFileSystemItem
for the givenDocumentModel
.getFileSystemItem
(DocumentModel doc, boolean includeDeleted) Gets theFileSystemItem
for the givenDocumentModel
.getFileSystemItem
(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint) Gets theFileSystemItem
for the givenDocumentModel
.getFileSystemItem
(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo) Gets theFileSystemItem
for the givenDocumentModel
.getFileSystemItem
(DocumentModel doc, FolderItem parentItem) getFileSystemItem
(DocumentModel doc, FolderItem parentItem, boolean includeDeleted) getFileSystemItem
(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint) getFileSystemItem
(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo) getFileSystemItemById
(String id, String parentId, NuxeoPrincipal principal) Gets theFileSystemItem
with the given id and parent id using a core session fetched with the given principal.getFileSystemItemById
(String id, NuxeoPrincipal principal) Gets theFileSystemItem
with the given id using a core session fetched with the given principal.getName()
Gets the factory unique name.void
handleParameters
(Map<String, String> parameters) Handles the factory parameters contributed through thefileSystemItemFactory
contribution.boolean
Returns true if the givenDocumentModel
is adaptable as aFileSystemItem
.boolean
isFileSystemItem
(DocumentModel doc, boolean includeDeleted) Returns true if the givenDocumentModel
is adaptable as aFileSystemItem
.boolean
isFileSystemItem
(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint) Returns true if the givenDocumentModel
is adaptable as aFileSystemItem
.void
setFolderName
(String folderName) void
Sets the factory unique name.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.nuxeo.drive.service.VirtualFolderItemFactory
getVirtualFolderItem
-
Field Details
-
FOLDER_NAME_PARAM
- See Also:
-
DEFAULT_FOLDER_NAME
- See Also:
-
name
-
folderName
-
-
Constructor Details
-
AbstractVirtualFolderItemFactory
public AbstractVirtualFolderItemFactory()
-
-
Method Details
-
getName
Description copied from interface:FileSystemItemFactory
Gets the factory unique name.- Specified by:
getName
in interfaceFileSystemItemFactory
-
setName
Description copied from interface:FileSystemItemFactory
Sets the factory unique name.- Specified by:
setName
in interfaceFileSystemItemFactory
-
handleParameters
Description copied from interface:FileSystemItemFactory
Handles the factory parameters contributed through thefileSystemItemFactory
contribution.- Specified by:
handleParameters
in interfaceFileSystemItemFactory
-
isFileSystemItem
Description copied from interface:FileSystemItemFactory
Returns true if the givenDocumentModel
is adaptable as aFileSystemItem
.- Specified by:
isFileSystemItem
in interfaceFileSystemItemFactory
- See Also:
-
isFileSystemItem
Description copied from interface:FileSystemItemFactory
Returns true if the givenDocumentModel
is adaptable as aFileSystemItem
. IfincludeDeleted
is true no filter is applied on the "trashed" state, else if the document is in this state it is not considered as adaptable as aFileSystemItem
, thus the method returns false.- Specified by:
isFileSystemItem
in interfaceFileSystemItemFactory
-
isFileSystemItem
public boolean isFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint) Description copied from interface:FileSystemItemFactory
Returns true if the givenDocumentModel
is adaptable as aFileSystemItem
.If
includeDeleted
is true no filter is applied on the "trashed" state, else if the document is in this state it is not considered as adaptable as aFileSystemItem
, thus the method returns false.If
relaxSyncRootConstraint
is true no filter is applied on the synchronization root aspect for the current user.- Specified by:
isFileSystemItem
in interfaceFileSystemItemFactory
-
getFileSystemItem
Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
for the givenDocumentModel
.- Specified by:
getFileSystemItem
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if theDocumentModel
is not adaptable as aFileSystemItem
- See Also:
-
getFileSystemItem
Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
for the givenDocumentModel
. IfincludeDeleted
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 aFileSystemItem
, thus the method returns null.- Specified by:
getFileSystemItem
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if theDocumentModel
is not adaptable as aFileSystemItem
- See Also:
-
getFileSystemItem
public FileSystemItem getFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint) Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
for the givenDocumentModel
.If
includeDeleted
is true no filter is applied on the "trashed" state, else if the document is in this state it is not considered as adaptable as aFileSystemItem
, thus the method returns null.If
relaxSyncRootConstraint
is true no filter is applied on the synchronization root aspect for the current user.- Specified by:
getFileSystemItem
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if theDocumentModel
is not adaptable as aFileSystemItem
- See Also:
-
getFileSystemItem
public FileSystemItem getFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo) Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
for the givenDocumentModel
.If
includeDeleted
is true no filter is applied on the "trashed" state, else if the document is in this state it is not considered as adaptable as aFileSystemItem
, 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 theLock
is fetched from theDocumentModel
and set on the returnedFileSystemItem
.- Specified by:
getFileSystemItem
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if theDocumentModel
is not adaptable as aFileSystemItem
- See Also:
-
getFileSystemItem
Description copied from interface:FileSystemItemFactory
- Specified by:
getFileSystemItem
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if theDocumentModel
is not adaptable as aFileSystemItem
- See Also:
-
getFileSystemItem
public FileSystemItem getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted) Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
for the givenDocumentModel
forcing its parent with the givenparentItem
. IfincludeDeleted
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 aFileSystemItem
, thus the method returns null.- Specified by:
getFileSystemItem
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if theDocumentModel
is not adaptable as aFileSystemItem
-
getFileSystemItem
public FileSystemItem getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint) Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
for the givenDocumentModel
forcing its parent with the givenparentItem
.If
includeDeleted
is true no filter is applied on the "trashed" state, else if the document is in this state it is not considered as adaptable as aFileSystemItem
, thus the method returns null.If
relaxSyncRootConstraint
is true no filter is applied on the synchronization root aspect for the current user.- Specified by:
getFileSystemItem
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if theDocumentModel
is not adaptable as aFileSystemItem
-
getFileSystemItem
public FileSystemItem getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo) Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
for the givenDocumentModel
forcing its parent with the givenparentItem
.If
includeDeleted
is true no filter is applied on the "trashed" state, else if the document is in this state it is not considered as adaptable as aFileSystemItem
, 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 theLock
is fetched from theDocumentModel
and set on the returnedFileSystemItem
.- Specified by:
getFileSystemItem
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if theDocumentModel
is not adaptable as aFileSystemItem
-
canHandleFileSystemItemId
Description copied from interface:FileSystemItemFactory
Returns true if the givenFileSystemItem
id can be handled by this factory. It is typically the case when the factory has been responsible for generating theFileSystemItem
.- Specified by:
canHandleFileSystemItemId
in interfaceFileSystemItemFactory
-
exists
Description copied from interface:FileSystemItemFactory
Returns true if aFileSystemItem
with the given id exists for the given principal.- Specified by:
exists
in interfaceFileSystemItemFactory
-
getFileSystemItemById
Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
with the given id using a core session fetched with the given principal.- Specified by:
getFileSystemItemById
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if none matches the given id
-
getFileSystemItemById
Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
with the given id and parent id using a core session fetched with the given principal.- Specified by:
getFileSystemItemById
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if none matches the given id and parent id
-
getFolderName
- Specified by:
getFolderName
in interfaceVirtualFolderItemFactory
-
setFolderName
- Specified by:
setFolderName
in interfaceVirtualFolderItemFactory
-