Difference between revisions of "OKMNote"
From OpenKM Documentation
(Created page with '__TOC__ Methods related to document notes management. == Note add(String token, String nodePath, String text) == Add a note to a document. '''Parameters''' * ''token'' - The s…') |
(→Note[] list(String token, String nodePath)) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 16: | Line 16: | ||
'''Throws''' | '''Throws''' | ||
* ''LockException'' - A locked document can't be modified. | * ''LockException'' - A locked document can't be modified. | ||
| + | * ''PathNotFoundException'' - If there is no document in the repository with this path. | ||
| + | * ''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. | ||
| + | |||
| + | '''Since''' | ||
| + | * OpenKM 5.0 | ||
| + | |||
| + | == Note get(String token, String notePath) == | ||
| + | Get note from document | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''notePath'' - The path that identifies an unique document note. | ||
| + | |||
| + | '''Returns''' | ||
| + | * The required note associated to the document. | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''LockException'' - A locked document can't be modified. | ||
| + | * ''PathNotFoundException'' - If there is no document in the repository with this path. | ||
| + | * ''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. | ||
| + | |||
| + | '''Since''' | ||
| + | * OpenKM 5.0 | ||
| + | |||
| + | == void remove(String token, String notePath) == | ||
| + | Remove a note from a document. | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''notePath'' - The path that identifies an unique document note. | ||
| + | |||
| + | '''Returns''' | ||
| + | * None | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''LockException'' - A locked document can't be modified. | ||
| + | * ''PathNotFoundException'' - If there is no document in the repository with this path. | ||
| + | * ''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. | ||
| + | |||
| + | '''Since''' | ||
| + | * OpenKM 5.0 | ||
| + | |||
| + | == void set(String token, String notePath, String text) == | ||
| + | Set a new text to document note. | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''notePath'' - The path that identifies an unique document note. | ||
| + | * ''text'' - The message text. | ||
| + | |||
| + | '''Returns''' | ||
| + | * None | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''LockException'' - A locked document can't be modified. | ||
| + | * ''PathNotFoundException'' - If there is no document in the repository with this path. | ||
| + | * ''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. | ||
| + | |||
| + | '''Since''' | ||
| + | * OpenKM 5.0 | ||
| + | |||
| + | == Note[] list(String token, String nodePath) == | ||
| + | Retrieve a list of notes from a document. | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''nodePath'' - The path that identifies an unique document. | ||
| + | |||
| + | '''Returns''' | ||
| + | * An array with the document notes. | ||
| + | |||
| + | '''Throws''' | ||
* ''PathNotFoundException'' - If there is no document in the repository with this path. | * ''PathNotFoundException'' - If there is no document in the repository with this path. | ||
* ''AccessDeniedException'' - If there is any security problem: you can't access this document because of lack of permissions. | * ''AccessDeniedException'' - If there is any security problem: you can't access this document because of lack of permissions. | ||
Latest revision as of 10:46, 21 October 2010
Contents
Methods related to document notes management.
Note add(String token, String nodePath, String text)
Add a note to a document.
Parameters
- token - The session authorization token.
- nodePath - The path that identifies an unique document.
- text - The message text.
Returns
- A note object with the new created note properties.
Throws
- LockException - A locked document can't be modified.
- PathNotFoundException - If there is no document in the repository with this path.
- 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.
Since
- OpenKM 5.0
Note get(String token, String notePath)
Get note from document
Parameters
- token - The session authorization token.
- notePath - The path that identifies an unique document note.
Returns
- The required note associated to the document.
Throws
- LockException - A locked document can't be modified.
- PathNotFoundException - If there is no document in the repository with this path.
- 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.
Since
- OpenKM 5.0
void remove(String token, String notePath)
Remove a note from a document.
Parameters
- token - The session authorization token.
- notePath - The path that identifies an unique document note.
Returns
- None
Throws
- LockException - A locked document can't be modified.
- PathNotFoundException - If there is no document in the repository with this path.
- 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.
Since
- OpenKM 5.0
void set(String token, String notePath, String text)
Set a new text to document note.
Parameters
- token - The session authorization token.
- notePath - The path that identifies an unique document note.
- text - The message text.
Returns
- None
Throws
- LockException - A locked document can't be modified.
- PathNotFoundException - If there is no document in the repository with this path.
- 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.
Since
- OpenKM 5.0
Note[] list(String token, String nodePath)
Retrieve a list of notes from a document.
Parameters
- token - The session authorization token.
- nodePath - The path that identifies an unique document.
Returns
- An array with the document notes.
Throws
- PathNotFoundException - If there is no document in the repository with this path.
- 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.
Since
- OpenKM 5.0
