Index (eXo Documents - API 7.0.2-RC01 API)

A B C D E F G H I J M N O P R S T U V Z
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractNode - Class in org.exoplatform.documents.model
AbstractNode() - Constructor for class org.exoplatform.documents.model.AbstractNode
ActionData - Class in org.exoplatform.documents.model
ActionData() - Constructor for class org.exoplatform.documents.model.ActionData
ActionStatus - Enum Class in org.exoplatform.documents.model
ActionType - Enum Class in org.exoplatform.documents.model
addCreatedFile(String) - Method in class org.exoplatform.documents.model.ActionData
addDocumentsSizeStat(long, long) - Method in interface org.exoplatform.documents.service.DocumentFileService: Calculate total size of a space or user drive and store the result in new analytics entry
addDuplicatedFile(String) - Method in class org.exoplatform.documents.model.ActionData
addFailedFile(String) - Method in class org.exoplatform.documents.model.ActionData
addIgnoredFile(String) - Method in class org.exoplatform.documents.model.ActionData
addUpdatedFile(String) - Method in class org.exoplatform.documents.model.ActionData
ALL - Enum constant in enum class org.exoplatform.documents.model.PermissionRole

B

BreadCrumbItem - Class in org.exoplatform.documents.model
BreadCrumbItem() - Constructor for class org.exoplatform.documents.model.BreadCrumbItem

C

calculateFilesSize(Long, Identity) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage
canAccess(String, Identity) - Method in interface org.exoplatform.documents.service.DocumentFileService
canAccess(String, Identity) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage
canAddDocument(String, String) - Method in interface org.exoplatform.documents.service.DocumentFileService: verify if current user can add document
cancelBulkAction(String, String) - Method in interface org.exoplatform.documents.service.DocumentFileService: Cancel any bulk action by action ID
cancelBulkAction(String, String) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Cancel any bulk action by action ID
CANCELED - Enum constant in enum class org.exoplatform.documents.model.ActionStatus
canImport(Identity) - Method in interface org.exoplatform.documents.service.DocumentFileService: Check if the current user can import documents from zip
canImport(Identity) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage
CANNOT_UNZIP_FILE - Enum constant in enum class org.exoplatform.documents.model.ActionStatus
compareTo(FileVersion) - Method in class org.exoplatform.documents.model.FileVersion
countDeletedDocuments() - Method in interface org.exoplatform.documents.service.DocumentFileService: Counts the total number of deleted documents in the trash.
countDeletedDocuments() - Method in interface org.exoplatform.documents.storage.JCRDeleteFileStorage: Counts the total number of deleted documents in the trash.
countDeletedDocuments() - Method in interface org.exoplatform.documents.storage.TrashStorage: Counts the total number of deleted documents in the trash.
CREATED_DATE - Enum constant in enum class org.exoplatform.documents.constant.DocumentSortField
createFolder(long, String, String, String, long) - Method in interface org.exoplatform.documents.service.DocumentFileService
createFolder(long, String, String, String, Identity) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage
createNewVersion(String, String, InputStream) - Method in interface org.exoplatform.documents.service.DocumentFileService: Creates a new version from an input stream
createNewVersion(String, String, InputStream) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Creates a new version from an input stream
createPublicDocumentAccess(long, String, String, Long, boolean) - Method in interface org.exoplatform.documents.service.PublicDocumentAccessService: Creates a public access for a document
createShortcut(String, String, String, String) - Method in interface org.exoplatform.documents.service.DocumentFileService: Creates a shortcut for a document
createShortcut(String, String, String, String) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Creates a shortcut for a document
CREATING_DOCUMENTS - Enum constant in enum class org.exoplatform.documents.model.ActionStatus

D

DELETE - Enum constant in enum class org.exoplatform.documents.model.ActionType
deleteDocument(String, String, boolean, boolean, long, Identity, long) - Method in interface org.exoplatform.documents.storage.JCRDeleteFileStorage: Delete document (Move to trash)
deleteDocument(String, String, boolean, long, long) - Method in interface org.exoplatform.documents.service.DocumentFileService: Delete a document.
deleteDocument(Session, String, String, boolean, boolean, long, Identity, long) - Method in interface org.exoplatform.documents.storage.JCRDeleteFileStorage: Delete document (Move to trash)
deleteDocumentPermanently(String) - Method in interface org.exoplatform.documents.service.DocumentFileService: Delete a document from the trash based on the specified trash node path.
deleteDocumentPermanently(String) - Method in interface org.exoplatform.documents.storage.JCRDeleteFileStorage: Delete a document from the trash based on the specified trash node path.
deleteDocumentPermanently(String, String) - Method in interface org.exoplatform.documents.storage.JCRDeleteFileStorage: Delete a document from the trash based on the specified trash node path.
deleteDocuments(int, List<AbstractNode>, long) - Method in interface org.exoplatform.documents.service.DocumentFileService: Delete a list of documents.
deleteDocuments(int, List<AbstractNode>, Identity, long) - Method in interface org.exoplatform.documents.storage.JCRDeleteFileStorage: Delete a list of document (Move to trash)
deleteDocumentsPermanently(int, List<AbstractNode>, long) - Method in interface org.exoplatform.documents.service.DocumentFileService: Delete a list of documents from the trash.
deleteDocumentsPermanently(int, List<AbstractNode>, Identity) - Method in interface org.exoplatform.documents.storage.JCRDeleteFileStorage: Delete a list of documents from the trash.
DocumentFileService - Interface in org.exoplatform.documents.service
DocumentFileStorage - Interface in org.exoplatform.documents.storage
DocumentFolderFilter - Class in org.exoplatform.documents.model
DocumentFolderFilter() - Constructor for class org.exoplatform.documents.model.DocumentFolderFilter
DocumentGroupsSize - Class in org.exoplatform.documents.model
DocumentGroupsSize() - Constructor for class org.exoplatform.documents.model.DocumentGroupsSize
DocumentNodeFilter - Class in org.exoplatform.documents.model
DocumentNodeFilter() - Constructor for class org.exoplatform.documents.model.DocumentNodeFilter
DocumentSortField - Enum Class in org.exoplatform.documents.constant
DocumentsSize - Class in org.exoplatform.documents.model
DocumentsSize() - Constructor for class org.exoplatform.documents.model.DocumentsSize
DocumentTimelineFilter - Class in org.exoplatform.documents.model
DocumentTimelineFilter() - Constructor for class org.exoplatform.documents.model.DocumentTimelineFilter
DONE_SUCCESSFULLY - Enum constant in enum class org.exoplatform.documents.model.ActionStatus
DONE_WITH_ERRORS - Enum constant in enum class org.exoplatform.documents.model.ActionStatus
DOWNLOAD - Enum constant in enum class org.exoplatform.documents.model.ActionType
downloadDocuments(int, List<AbstractNode>, long) - Method in interface org.exoplatform.documents.service.DocumentFileService: Download a list of documents.
downloadDocuments(int, List<AbstractNode>, Identity, long) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage
downloadFolder(String) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Download a zipped folder
DownloadItem - Class in org.exoplatform.documents.model
DownloadItem() - Constructor for class org.exoplatform.documents.model.DownloadItem
downloadZippedFolder(String) - Method in interface org.exoplatform.documents.service.ExternalDownloadService: Download a zipped folder
DUPLICATE - Enum constant in enum class org.exoplatform.documents.model.ActionType
duplicateDocument(long, String, String, long) - Method in interface org.exoplatform.documents.service.DocumentFileService: Duplicate the given node.
duplicateDocument(long, String, String, Identity) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Duplicate the given node.

E

ExternalDownloadService - Interface in org.exoplatform.documents.service

F

FAILED - Enum constant in enum class org.exoplatform.documents.model.ActionStatus
FILE_REMOVE_ACTIVITY - Static variable in interface org.exoplatform.documents.storage.TrashStorage
FileListingType - Enum Class in org.exoplatform.documents.constant
FileNode - Class in org.exoplatform.documents.model
FileNode() - Constructor for class org.exoplatform.documents.model.FileNode
FileVersion - Class in org.exoplatform.documents.model
FileVersion() - Constructor for class org.exoplatform.documents.model.FileVersion
FOLDER - Enum constant in enum class org.exoplatform.documents.constant.FileListingType
FolderNode - Class in org.exoplatform.documents.model
FolderNode() - Constructor for class org.exoplatform.documents.model.FolderNode
FullTreeItem - Class in org.exoplatform.documents.model
FullTreeItem() - Constructor for class org.exoplatform.documents.model.FullTreeItem

G

getAclUserIdentity(String) - Method in interface org.exoplatform.documents.service.DocumentFileService
getAllLinks(Node, String) - Method in interface org.exoplatform.documents.storage.TrashStorage: Get all links
getAllNodeInTrash(SessionProvider) - Method in interface org.exoplatform.documents.storage.TrashStorage: Get all nodes in trash location
getAllNodeInTrashByUser(SessionProvider, String) - Method in interface org.exoplatform.documents.storage.TrashStorage: Get all nodes by user in trash location
getBiggestDocuments(long, Identity, int, int) - Method in interface org.exoplatform.documents.service.DocumentFileService: Retrieves a list of accessible files, for a selected user, by applying the designated filter.
getBiggestDocuments(Long, Identity, int, int) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Retrieves a list of biggest accessible files, for a selected user.
getBreadcrumb(long, String, String, long) - Method in interface org.exoplatform.documents.service.DocumentFileService: Retrieves breadcrumb of the given node.
getBreadcrumb(long, String, String, Identity) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Retrieves breadcrumb of the given node.
getDefaultView(Long, String) - Method in interface org.exoplatform.documents.service.DocumentFileService: Get Stored default View for the current user
getDeletedDocuments(TrashElementNodeFilter) - Method in interface org.exoplatform.documents.service.DocumentFileService: Retrieves a list of trash elements that match the specified filter.
getDeletedDocuments(TrashElementNodeFilter) - Method in interface org.exoplatform.documents.storage.JCRDeleteFileStorage: Retrieves a list of trash elements that match the specified filter.
getDocumentDownloadItem(String) - Method in interface org.exoplatform.documents.service.ExternalDownloadService: Gets a download item of a given document
getDocumentDownloadItem(String) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Gets a download item of a given document
getDocumentItems(FileListingType, DocumentNodeFilter, int, int, long, boolean) - Method in interface org.exoplatform.documents.service.DocumentFileService: Retrieves a list of accessible folders and/or files, for a selected user, by applying the designated filter.
getDocumentsSizeStat(long, long) - Method in interface org.exoplatform.documents.service.DocumentFileService: Get the total size of a space or user drive
getDocumentsToDelete() - Method in interface org.exoplatform.documents.storage.JCRDeleteFileStorage
getDownloadZipBytes(int, String) - Method in interface org.exoplatform.documents.service.DocumentFileService: Get the zip for download by action ID
getDownloadZipBytes(int, String) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Get the zip for download by action ID
getFilesTimeline(DocumentTimelineFilter, int, int, long) - Method in interface org.exoplatform.documents.service.DocumentFileService: Retrieves a list of accessible files, for a selected user, by applying the designated filter.
getFilesTimeline(DocumentTimelineFilter, Identity, int, int) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Retrieves a list of accessible files, for a selected user, by applying the designated filter.
getFileVersions(String, String) - Method in interface org.exoplatform.documents.service.DocumentFileService: Retrieves versions of specific file
getFileVersions(String, String) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Retrieves versions of specific file
getFolderChildNodes(DocumentFolderFilter, int, int, long) - Method in interface org.exoplatform.documents.service.DocumentFileService: Retrieves a list of accessible files, for a selected user, by applying the designated filter.
getFolderChildNodes(DocumentFolderFilter, Identity, int, int) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Retrieves a list of accessible files, for a selected user, by applying the designated filter.
getFromAlias(String) - Static method in enum class org.exoplatform.documents.constant.DocumentSortField
getFullTreeData(long, String, long, boolean) - Method in interface org.exoplatform.documents.service.DocumentFileService: Retrieves breadcrumb of the given node.
getFullTreeData(long, String, Identity, boolean) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Retrieves breadcrumb of the given node.
getGroupDocumentsCount(DocumentTimelineFilter, long) - Method in interface org.exoplatform.documents.service.DocumentFileService: Retrieves the number of existing files by group.
getGroupDocumentsCount(DocumentTimelineFilter, Identity) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Retrieves the number of existing files by group.
getNewName(long, String, String, String) - Method in interface org.exoplatform.documents.service.DocumentFileService
getNewName(long, String, String, String) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage
getNodeByTrashId(String) - Method in interface org.exoplatform.documents.storage.TrashStorage: Get Node in trash folder by trashId
getPublicDocumentAccess(String) - Method in interface org.exoplatform.documents.service.PublicDocumentAccessService: Gets a document public access by its node id
getPublicDocumentAccessByNodeId(String) - Method in interface org.exoplatform.documents.storage.PublicDocumentAccessStorage: Gets a public access by its document id (nodeId)
getTrashElements(TrashElementNodeFilter) - Method in interface org.exoplatform.documents.storage.TrashStorage: Retrieves a list of trash elements that match the specified filter.
getTrashHomeNode() - Method in interface org.exoplatform.documents.storage.TrashStorage: Get the trash hone's node

H

hasDocumentPublicAccess(String) - Method in interface org.exoplatform.documents.service.PublicDocumentAccessService: Checks if a document has public access
hasEditPermissionOnDocument(String, long) - Method in interface org.exoplatform.documents.service.DocumentFileService: Checks if user has edit permission on document
hasEditPermissions(String, Identity) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Checks if user has edit permission on document

I

IMPORT_LIMIT_EXCEEDED - Enum constant in enum class org.exoplatform.documents.model.ActionStatus
IMPORT_LIMIT_NOT_EXCEEDED - Enum constant in enum class org.exoplatform.documents.model.ActionStatus
IMPORT_ZIP - Enum constant in enum class org.exoplatform.documents.model.ActionType
importFiles(String, String, String, String, String, Identity, long) - Method in interface org.exoplatform.documents.service.DocumentFileService: Import list of documents from an uploaded zip
importFiles(String, Space, String, String, String, String, Identity, String, long) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Import list of documents from an uploaded zip
IN_PROGRESS - Enum constant in enum class org.exoplatform.documents.model.ActionStatus
incrementImportCount() - Method in class org.exoplatform.documents.model.ActionData
isDocumentPublicAccessValid(String, String) - Method in interface org.exoplatform.documents.service.PublicDocumentAccessService: Checks the validity of a public access
isFolder() - Method in class org.exoplatform.documents.model.AbstractNode
isInTrash(Node) - Method in interface org.exoplatform.documents.storage.TrashStorage: Check whether a given node is in Trash or not
isPublicDocumentAccessExpired(String) - Method in interface org.exoplatform.documents.service.PublicDocumentAccessService: Checks if public access expired

J

JCRDeleteFileStorage - Interface in org.exoplatform.documents.storage

M

MANAGERS_REDACTORS - Enum constant in enum class org.exoplatform.documents.model.PermissionRole
MODIFIED_DATE - Enum constant in enum class org.exoplatform.documents.constant.DocumentSortField
MOVE - Enum constant in enum class org.exoplatform.documents.model.ActionType
moveDocument(long, String, String, long, String) - Method in interface org.exoplatform.documents.service.DocumentFileService: Move the given node.
moveDocument(long, String, String, Identity, String) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Move the given node.
moveDocument(Session, long, String, String, Identity, String) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Move the given node.
moveDocuments(int, long, List<AbstractNode>, String, long) - Method in interface org.exoplatform.documents.service.DocumentFileService: Move list of documents in bulk
moveDocuments(int, long, List<AbstractNode>, String, Identity, long) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Move list of documents in bulk
moveToTrash(Node, SessionProvider) - Method in interface org.exoplatform.documents.storage.TrashStorage: Move node to trash location
moveToTrash(Node, SessionProvider, int) - Method in interface org.exoplatform.documents.storage.TrashStorage: Move node to trash location with deep

N

NAME - Enum constant in enum class org.exoplatform.documents.constant.DocumentSortField
NodePermission - Class in org.exoplatform.documents.model
NodePermission() - Constructor for class org.exoplatform.documents.model.NodePermission
notifyMember(String, long) - Method in interface org.exoplatform.documents.service.DocumentFileService
notifyMember(String, long) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage

O

org.exoplatform.documents.constant - package org.exoplatform.documents.constant
org.exoplatform.documents.model - package org.exoplatform.documents.model
org.exoplatform.documents.service - package org.exoplatform.documents.service
org.exoplatform.documents.storage - package org.exoplatform.documents.storage

P

PERMANENTLY_DELETE - Enum constant in enum class org.exoplatform.documents.model.ActionType
PermissionEntry - Class in org.exoplatform.documents.model
PermissionEntry() - Constructor for class org.exoplatform.documents.model.PermissionEntry
PermissionRole - Enum Class in org.exoplatform.documents.model
PublicDocumentAccess - Class in org.exoplatform.documents.model
PublicDocumentAccess(Long, String, String, String, Date) - Constructor for class org.exoplatform.documents.model.PublicDocumentAccess
PublicDocumentAccessService - Interface in org.exoplatform.documents.service
PublicDocumentAccessStorage - Interface in org.exoplatform.documents.storage

R

removePublicDocumentAccess(String) - Method in interface org.exoplatform.documents.storage.PublicDocumentAccessStorage: Removes an existing document public access
removeRelations(Node, SessionProvider) - Method in interface org.exoplatform.documents.storage.TrashStorage: Removes all 'relationable' property of nodes that have relation to this node
renameDocument(long, String, String, long) - Method in interface org.exoplatform.documents.service.DocumentFileService
renameDocument(long, String, String, Identity) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage
RESTORE - Enum constant in enum class org.exoplatform.documents.model.ActionType
restoreDocumentFromTrash(String) - Method in interface org.exoplatform.documents.service.DocumentFileService: Restores a document from the trash based on the specified trash node path.
restoreDocuments(int, List<AbstractNode>, long) - Method in interface org.exoplatform.documents.service.DocumentFileService: Restore a list of documents from the trash.
restoreDocuments(int, List<AbstractNode>, Identity) - Method in interface org.exoplatform.documents.storage.JCRDeleteFileStorage: Restore a list of documents from the trash.
restoreFromTrash(String) - Method in interface org.exoplatform.documents.storage.JCRDeleteFileStorage: Restores a document from the trash based on the specified trash node path.
restoreFromTrash(String, SessionProvider) - Method in interface org.exoplatform.documents.storage.TrashStorage: Restore node from trash
restoreVersion(String, String) - Method in interface org.exoplatform.documents.service.DocumentFileService: restore document version
restoreVersion(String, String) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: restore document version
revokeDocumentPublicAccess(String) - Method in interface org.exoplatform.documents.service.PublicDocumentAccessService: Revokes a document public access

S

savePublicDocumentAccess(PublicDocumentAccess, long) - Method in interface org.exoplatform.documents.storage.PublicDocumentAccessStorage: Save a created document public access
setDefaultView(Long, String, String) - Method in interface org.exoplatform.documents.service.DocumentFileService: Set default View for the current user
shareDocument(String, long, long, boolean) - Method in interface org.exoplatform.documents.service.DocumentFileService: Shares a document with given user or space
shareDocument(String, long, Identity, boolean) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: Shares a document with given user or space
STARTED - Enum constant in enum class org.exoplatform.documents.model.ActionStatus
SymlinkNavigation - Class in org.exoplatform.documents.model
SymlinkNavigation() - Constructor for class org.exoplatform.documents.model.SymlinkNavigation

T

TIMELINE - Enum constant in enum class org.exoplatform.documents.constant.FileListingType
TrashElementNode - Class in org.exoplatform.documents.model
TrashElementNode() - Constructor for class org.exoplatform.documents.model.TrashElementNode
TrashElementNodeFilter - Class in org.exoplatform.documents.model
TrashElementNodeFilter() - Constructor for class org.exoplatform.documents.model.TrashElementNodeFilter
TrashStorage - Interface in org.exoplatform.documents.storage: This service used to move documents to trash foder or restore

U

undoDelete(String, long) - Method in interface org.exoplatform.documents.storage.JCRDeleteFileStorage: Undo delete document
undoDeleteDocument(String, long) - Method in interface org.exoplatform.documents.service.DocumentFileService: Undo delete a document (Cancel the delete action).
unShareDocument(String, long) - Method in interface org.exoplatform.documents.service.DocumentFileService
unShareDocument(String, long) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage
UNZIPPING - Enum constant in enum class org.exoplatform.documents.model.ActionStatus
updateDocumentDescription(long, String, String, long) - Method in interface org.exoplatform.documents.service.DocumentFileService
updateDocumentDescription(long, String, String, Identity) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage
updatePermissions(String, NodePermission, long) - Method in interface org.exoplatform.documents.service.DocumentFileService
updatePermissions(String, NodePermission, Identity) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage
updateVersionSummary(String, String, String, String) - Method in interface org.exoplatform.documents.service.DocumentFileService: update or add a version summary
updateVersionSummary(String, String, String, String) - Method in interface org.exoplatform.documents.storage.DocumentFileStorage: update or add a version summary

V

valueOf(String) - Static method in enum class org.exoplatform.documents.constant.DocumentSortField: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.exoplatform.documents.constant.FileListingType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.exoplatform.documents.model.ActionStatus: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.exoplatform.documents.model.ActionType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.exoplatform.documents.model.PermissionRole: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.exoplatform.documents.constant.DocumentSortField: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.exoplatform.documents.constant.FileListingType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.exoplatform.documents.model.ActionStatus: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.exoplatform.documents.model.ActionType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.exoplatform.documents.model.PermissionRole: Returns an array containing the constants of this enum class, in the order they are declared.

Z

ZIP_FILE_CREATION - Enum constant in enum class org.exoplatform.documents.model.ActionStatus

A B C D E F G H I J M N O P R S T U V Z
All Classes and Interfaces|All Packages|Constant Field Values