public interface RepositoryModule
Modifier and Type | Method and Description |
---|---|
void |
copyAttributes(String token,
String srcId,
String dstId,
ExtendedAttributes extAttr)
Copy attributes from a node to another.
|
AppVersion |
getAppVersion(String token)
Retrieve application version.
|
Folder |
getCategoriesFolder(String token)
Obtain the categories folder of the repository.
|
Folder |
getMailFolder(String token)
Obtain the personal mails folder of the repository.
|
Folder |
getMailFolderBase(String token) |
String |
getNodePath(String token,
String uuid)
Obtain the node path with a given uuid.
|
String |
getNodeUuid(String token,
String path)
Obtain the node uuid with a given path.
|
Folder |
getPersonalFolder(String token)
Obtain the personal documents folder of the repository.
|
Folder |
getPersonalFolderBase(String token) |
String |
getRepositoryUuid(String token)
Get the unique repository identifier
|
Folder |
getRootFolder(String token)
Obtain the root folder of the repository.
|
Folder |
getTemplatesFolder(String token)
Obtain the template folder of the repository.
|
Folder |
getThesaurusFolder(String token)
Obtain the thesaurus folder of the repository.
|
Folder |
getTrashFolder(String token)
Obtains the user trash folder.
|
Folder |
getTrashFolderBase(String token) |
String |
getUpdateMessage(String token)
Get the update message, if any.
|
boolean |
hasNode(String token,
String nodeId)
Test if a node path exists
|
void |
purgeTrash(String token)
Remove all the items in the user trash folder for ever.
|
Folder getRootFolder(String token) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
PathNotFoundException
- If there is no root folder node in the repository.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
Folder getTrashFolder(String token) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
PathNotFoundException
- If there is no user trash folder node in the repository.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
Folder getTrashFolderBase(String token) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
Folder getTemplatesFolder(String token) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
PathNotFoundException
- If there is no templates folder node in the repository.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
Folder getPersonalFolder(String token) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
PathNotFoundException
- If there is no user documents folder node in the repository.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
Folder getPersonalFolderBase(String token) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
Folder getMailFolder(String token) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
PathNotFoundException
- If there is no user documents folder node in the repository.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
Folder getMailFolderBase(String token) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
Folder getThesaurusFolder(String token) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
PathNotFoundException
- If there is no user documents folder node in the repository.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
Folder getCategoriesFolder(String token) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
PathNotFoundException
- If there is no user documents folder node in the repository.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
void purgeTrash(String token) throws PathNotFoundException, AccessDeniedException, LockException, RepositoryException, DatabaseException
AccessDeniedException
- If there is any security problem:
you can't modify the user deleted folders and documents because
of lack of permissions.RepositoryException
- If there is any general repository problem.PathNotFoundException
LockException
DatabaseException
String getUpdateMessage(String token) throws RepositoryException
RepositoryException
- If there is any general repository problem.String getRepositoryUuid(String token) throws RepositoryException
RepositoryException
- If there is any general repository problem.boolean hasNode(String token, String nodeId) throws AccessDeniedException, RepositoryException, DatabaseException
nodeId
- The path that identifies an unique document or its UUID.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
String getNodePath(String token, String uuid) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
uuid
- An unique node identifierPathNotFoundException
- If there is no user node in the repository with this uuid.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
String getNodeUuid(String token, String path) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
path
- An unique path node identifierPathNotFoundException
- If there is no user node in the repository with this uuid.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
AppVersion getAppVersion(String token) throws AccessDeniedException, RepositoryException, DatabaseException
token
- Security token.AccessDeniedException
RepositoryException
DatabaseException
void copyAttributes(String token, String srcId, String dstId, ExtendedAttributes extAttr) throws AccessDeniedException, PathNotFoundException, DatabaseException
token
- Security token.srcId
- The path that identifies an unique document or its UUID.dstId
- The path that identifies an unique document or its UUID.extAttr
- Which attributes need to be copied.AccessDeniedException
PathNotFoundException
DatabaseException
Copyright © 2017 Open Knowledge Management System S.L.. All rights reserved.