public interface DocumentModule
Modifier and Type | Method and Description |
---|---|
void |
cancelCheckout(String token,
String docPath)
Cancel a previous checked out state in a document.
|
Version |
checkin(String token,
String docPath,
InputStream is,
String comment)
Check in the document to create a new version.
|
Version |
checkin(String token,
String docPath,
InputStream is,
String comment,
int increment)
Check in the document to create a new version.
|
void |
checkout(String token,
String docPath)
Checkout the document to edit it.
|
void |
copy(String token,
String docPath,
String dstPath)
Copy a document to another location in the repository.
|
Document |
create(String token,
Document doc,
InputStream is)
Creates a new document in the repository.
|
void |
delete(String token,
String docPath)
Deletes a document from the repository.
|
void |
extendedCopy(String token,
String docPath,
String dstPath,
String docName,
ExtendedAttributes extAttr)
Copy a document to another location in the repository.
|
void |
forceCancelCheckout(String token,
String docPath)
Force to cancel a previous checked out state in a document.
|
void |
forceUnlock(String token,
String docPath)
For document unlock, so will be editable for other users.
|
List<Document> |
getChildren(String token,
String fldId)
Retrieve a list of children documents from an existing folder.
|
List<Document> |
getChilds(String token,
String fldId)
Deprecated.
|
InputStream |
getContent(String token,
String docId,
boolean checkout)
Obtain document content from the repository.
|
InputStream |
getContentByVersion(String token,
String docId,
String versionId)
Obtain document content from the repository.
|
LockInfo |
getLockInfo(String token,
String docPath)
Returns a lock information.
|
String |
getPath(String token,
String uuid)
Get the document path from a UUID
|
Document |
getProperties(String token,
String docId)
Obtain document properties from the repository.
|
List<Version> |
getVersionHistory(String token,
String docId)
Get the document version history.
|
long |
getVersionHistorySize(String token,
String docId)
Get the version size of a Document.
|
boolean |
isCheckedOut(String token,
String docPath)
Test if a node has been already checked out.
|
boolean |
isLocked(String token,
String docPath)
Tell if a document is locked.
|
boolean |
isValid(String token,
String docId)
Test if a document path is valid.
|
LockInfo |
lock(String token,
String docPath)
Lock a document, so only is editable by the locker.
|
void |
move(String token,
String docPath,
String fldPath)
Move a document to another location in the repository.
|
void |
purge(String token,
String docPath)
Deletes definitively a document from the repository.
|
void |
purgeVersionHistory(String token,
String docPath)
Purge a Document version history, so delete all previous versions but last one.
|
Document |
rename(String token,
String docPath,
String newName)
Rename a document in the repository.
|
void |
restoreVersion(String token,
String docPath,
String versionId)
Revert the document to an specific previous version.
|
void |
setProperties(String token,
Document doc)
Set document properties in the repository.
|
void |
unlock(String token,
String docPath)
Unlock a document, so will be editable for other users.
|
Document create(String token, Document doc, InputStream is) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, IOException, DatabaseException, ExtensionException, AutomationException
doc
- A document object with the new document properties.content
- The document content in bytes.UnsupportedMimeTypeException
- If the uploaded file has an unsupported MIME type.FileSizeExceededException
- If the document content is biggest than the maximum accepted.PathNotFoundException
- If the parent folder doesn't exist.ItemExistsException
- If there is already a document in the repository with the same name.AccessDeniedException
- If there is any security problem: you can't modify the parent document folder
because of lack of permissions.RepositoryException
- If there is any general repository problem.IOException
- An error when inserting document data into the repository.UserQuotaExceededException
VirusDetectedException
DatabaseException
ExtensionException
AutomationException
void delete(String token, String docPath) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException
docPath
- The path that identifies an unique document.LockException
- Can't delete a locked document.PathNotFoundException
- If there is no document in this repository path.AccessDeniedException
- If there is any security problem: you can't modify the document because of lack of
permissions.RepositoryException
- If there is any general repository problem.DatabaseException
ExtensionException
Document rename(String token, String docPath, String newName) throws PathNotFoundException, ItemExistsException, AccessDeniedException, LockException, RepositoryException, DatabaseException, ExtensionException
docPath
- The path that identifies an unique document.newName
- The new folder name.PathNotFoundException
- If there is no document in this repository path.ItemExistsException
- If there is already a document in the repository with the same name in the same path.AccessDeniedException
- If there is any security problem: you can't modify the document because of lack of
permissions.RepositoryException
- If there is any general repository problem.LockException
DatabaseException
ExtensionException
Document getProperties(String token, String docId) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
@param
- docId The path that identifies an unique document or its UUID.PathNotFoundException
- If there is no document in this repository path. you can't modify the document
because of lack of permissions.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
void setProperties(String token, Document doc) throws VersionException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
doc
- An document object with the propertiesVersionException
- A document checked in can't be modified.LockException
- A locked document can't be modified.PathNotFoundException
- If there is no document in this repository path.AccessDeniedException
- If there is any security problem: you can't modify the document because of lack of
permissions.RepositoryException
- If there is any general repository problem.DatabaseException
InputStream getContent(String token, String docId, boolean checkout) throws PathNotFoundException, AccessDeniedException, RepositoryException, IOException, DatabaseException
docId
- The path that identifies an unique document or its UUID.PathNotFoundException
- If there is no document in this repository path.AccessDeniedException
- If there is any security problem: you can't modify this document because of lack of
permissions. Related to extended security.RepositoryException
- If there is any general repository problem.IOException
- An error when retrieving document data from the repository.DatabaseException
InputStream getContentByVersion(String token, String docId, String versionId) throws RepositoryException, AccessDeniedException, PathNotFoundException, IOException, DatabaseException
docId
- The path that identifies an unique document or its UUID.versionId
- The id of the version to get the content from.AccessDeniedException
- If there is any security problem: you can't modify this document because of lack of
permissions.RepositoryException
- If there is any general repository problem.PathNotFoundException
- If there is no folder in the repository with this path.IOException
- An error when retrieving document data from the repository.DatabaseException
@Deprecated List<Document> getChilds(String token, String fldId) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
fldId
- The path that identifies an unique folder or its UUID.PathNotFoundException
- If there is no folder in this repository path.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
List<Document> getChildren(String token, String fldId) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
fldId
- The path that identifies an unique folder or its UUID.PathNotFoundException
- If there is no folder in this repository path.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
void checkout(String token, String docPath) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
docPath
- The path that identifies an unique document.LockException
- A locked document can't be modified.PathNotFoundException
- If there is no document in this repository path.AccessDeniedException
- If there is any security problem: you can't modify the document because of lack of
permissions.RepositoryException
- If there is any general repository problem.DatabaseException
void cancelCheckout(String token, String docPath) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
docPath
- The path that identifies an unique document.LockException
- A locked document can't be modified.PathNotFoundException
- If there is no document in this repository path.AccessDeniedException
- If there is any security problem: you can't modify the document because of lack of
permissions.RepositoryException
- If there is any general repository problem.DatabaseException
void forceCancelCheckout(String token, String docPath) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, PrincipalAdapterException
docPath
- The path that identifies an unique document.LockException
- A locked document can't be modified.PathNotFoundException
- If there is no document in this repository path.AccessDeniedException
- If there is any security problem: you can't modify the document because of lack of
permissions.RepositoryException
- If there is any general repository problem.DatabaseException
PrincipalAdapterException
boolean isCheckedOut(String token, String docPath) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
docPath
- The path that identifies an unique document.PathNotFoundException
- If there is no document in this repository path.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
Version checkin(String token, String docPath, InputStream is, String comment) throws FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, LockException, VersionException, PathNotFoundException, AccessDeniedException, RepositoryException, IOException, DatabaseException, ExtensionException, AutomationException
docPath
- The path that identifies an unique document.comment
- A comment for this checkin.LockException
- A locked document can't be modified.VersionException
- If the nodes was not previously checked out.PathNotFoundException
- If there is no document in this repository path.AccessDeniedException
- If there is any security problem: you can't modify the document because of lack of
permissions.RepositoryException
- If there is any general repository problem.FileSizeExceededException
UserQuotaExceededException
VirusDetectedException
IOException
DatabaseException
ExtensionException
AutomationException
Version checkin(String token, String docPath, InputStream is, String comment, int increment) throws FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, LockException, VersionException, PathNotFoundException, AccessDeniedException, RepositoryException, IOException, DatabaseException, ExtensionException, AutomationException
docPath
- The path that identifies an unique document.comment
- A comment for this checkin.increment
- Which increment should be increased.LockException
- A locked document can't be modified.VersionException
- If the nodes was not previously checked out.PathNotFoundException
- If there is no document in this repository path.AccessDeniedException
- If there is any security problem: you can't modify the document because of lack of
permissions.RepositoryException
- If there is any general repository problem.FileSizeExceededException
UserQuotaExceededException
VirusDetectedException
IOException
DatabaseException
ExtensionException
AutomationException
List<Version> getVersionHistory(String token, String docId) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
docId
- The path that identifies an unique document or its UUID.PathNotFoundException
- If there is no document in this repository path.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
LockInfo lock(String token, String docPath) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
docPath
- The path that identifies an unique document.LockException
- If the node is already locked.PathNotFoundException
- If there is no document in this repository path.AccessDeniedException
- If there is any security problem: you can't modify the document because of lack of
permissions.RepositoryException
- If there is any general repository problem.DatabaseException
void unlock(String token, String docPath) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
docPath
- The path that identifies an unique document.LockException
- If the node is not locked.PathNotFoundException
- If there is no document in this repository path.AccessDeniedException
- If there is any security problem: you can't modify the document because of lack of
permissions.RepositoryException
- If there is any general repository problem.DatabaseException
void forceUnlock(String token, String docPath) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, PrincipalAdapterException
docPath
- The path that identifies an unique document.LockException
- If the node is not locked.PathNotFoundException
- If there is no document in this repository path.AccessDeniedException
- If there is any security problem: you can't modify the document because of lack of
permissions.RepositoryException
- If there is any general repository problem.DatabaseException
PrincipalAdapterException
boolean isLocked(String token, String docPath) throws RepositoryException, AccessDeniedException, PathNotFoundException, DatabaseException
docPath
- The path that identifies an unique document.AccessDeniedException
- If there is any security problem: you can't access this document because of lack of
permissions.RepositoryException
- If there is any repository problem.PathNotFoundException
- If there is no document in the repository with this path.DatabaseException
LockInfo getLockInfo(String token, String docPath) throws RepositoryException, AccessDeniedException, PathNotFoundException, LockException, DatabaseException
docPath
- The path that identifies an unique document.AccessDeniedException
- If there is any security problem: you can't access this document because of lack of
permissions.RepositoryException
- If there is any repository problem.PathNotFoundException
- If there is no document in the repository with this path.LockException
- If the node is not locked.DatabaseException
void purge(String token, String docPath) throws LockException, AccessDeniedException, RepositoryException, PathNotFoundException, DatabaseException, ExtensionException
docPath
- The path that identifies an unique document.AccessDeniedException
- If there is any security problem: you can't access this document because of lack of
permissions.RepositoryException
- If there is any general repository problem.PathNotFoundException
- If there is no document in the repository with this path.LockException
DatabaseException
ExtensionException
void move(String token, String docPath, String fldPath) throws PathNotFoundException, ItemExistsException, AccessDeniedException, LockException, RepositoryException, DatabaseException, ExtensionException, AutomationException
docPath
- The path that identifies an unique document.fldPath
- The destination folder path.PathNotFoundException
- If the dstPath does not existsItemExistsException
- If there is already a document in the destination folder with the same name.AccessDeniedException
- If there is any security problem: you can't modify the document's parent folder or
the destination folder because of lack of permissions.RepositoryException
- If there is any general repository problem.LockException
DatabaseException
ExtensionException
AutomationException
void copy(String token, String docPath, String dstPath) throws ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, IOException, DatabaseException, UserQuotaExceededException, ExtensionException, AutomationException
docPath
- The path that identifies an unique document.dstPath
- The destination folder path.PathNotFoundException
- If the dstPath does not existsItemExistsException
- If there is already a document in the destination folder with the same name.AccessDeniedException
- If there is any security problem: you can't modify the document's parent folder or
the destination folder because of lack of permissions.RepositoryException
- If there is any general repository problem.IOException
DatabaseException
UserQuotaExceededException
ExtensionException
AutomationException
void extendedCopy(String token, String docPath, String dstPath, String docName, ExtendedAttributes extAttr) throws ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, IOException, DatabaseException, UserQuotaExceededException, ExtensionException, AutomationException
docPath
- The path that identifies an unique document.dstPath
- The destination folder path.docName
- The name of the new document or null if not changedextAttr
- Attributes to define what need to be duplicated.PathNotFoundException
- If the dstPath does not existsItemExistsException
- If there is already a document in the destination folder with the same name.AccessDeniedException
- If there is any security problem: you can't modify the document's parent folder or
the destination folder because of lack of permissions.RepositoryException
- If there is any general repository problem.IOException
DatabaseException
UserQuotaExceededException
ExtensionException
AutomationException
void restoreVersion(String token, String docPath, String versionId) throws PathNotFoundException, AccessDeniedException, LockException, RepositoryException, DatabaseException, ExtensionException
docPath
- The path that identifies an unique document.versionId
- The version id to revert to.PathNotFoundException
- If there is no document in this repository path.AccessDeniedException
- If there is any security problem: you can't modify the document because of lack of
permissions.RepositoryException
- If there is any general repository problem.LockException
DatabaseException
ExtensionException
void purgeVersionHistory(String token, String docPath) throws AccessDeniedException, PathNotFoundException, LockException, RepositoryException, DatabaseException
docPath
- The path that identifies an unique document.AccessDeniedException
- If there is any security problem: you can't access this folder because of lack of
permissions.RepositoryException
- If there is any general repository problem.PathNotFoundException
- If there is no folder in the repository with this path.LockException
DatabaseException
long getVersionHistorySize(String token, String docId) throws RepositoryException, AccessDeniedException, PathNotFoundException, DatabaseException
docId
- The path that identifies an unique document or its UUID.AccessDeniedException
- If there is any security problem: you can't access this folder because of lack of
permissions.RepositoryException
- If there is any general repository problem.PathNotFoundException
- If there is no folder in the repository with this path.DatabaseException
boolean isValid(String token, String docId) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
docId
- The path that identifies an unique document or its UUID.PathNotFoundException
- If the node does not exists.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
String getPath(String token, String uuid) throws AccessDeniedException, RepositoryException, DatabaseException
uuid
- The unique document id.AccessDeniedException
- If there is any security problem: you can't access this node because of lack of
permissions.RepositoryException
- If there is any problem.DatabaseException
Copyright © 2016. All rights reserved.