Difference between revisions of "OKMBookmark"
From OpenKM Documentation
(Created page with '__TOC__ Methods related to bookmark management. == Bookmark add(String token, String nodePath, String name) == Add a new bookmark which points to this document. '''Parameters'…') |
Ranoble.djn (talk | contribs) (→Bookmark[] getAll(String token)) |
||
| (6 intermediate revisions by one other user not shown) | |||
| Line 8: | Line 8: | ||
'''Parameters''' | '''Parameters''' | ||
* ''token'' - The session authorization token. | * ''token'' - The session authorization token. | ||
| − | * ''nodePath'' - A | + | * ''nodePath'' - A node path to be bookmarked. |
* ''name'' - The name of the bookmark. | * ''name'' - The name of the bookmark. | ||
| Line 15: | Line 15: | ||
'''Throws''' | '''Throws''' | ||
| + | * ''AccessDeniedException'' - If there is any security problem: you can't modify the node because of lack of permissions. | ||
* ''PathNotFoundException'' - If the parent folder doesn't exist. | * ''PathNotFoundException'' - If the parent folder doesn't exist. | ||
| − | * ''AccessDeniedException'' - If there is any security problem: you can't modify the | + | * ''RepositoryException'' - If there is any general repository problem. |
| + | |||
| + | '''Since''' | ||
| + | * OpenKM 5.0 | ||
| + | |||
| + | == Bookmark get(String token, int bmId) == | ||
| + | Get info from a previously created bookmark. | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''bmId'' - The unique bookmark id. | ||
| + | |||
| + | '''Returns''' | ||
| + | * The bookmark object. | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''AccessDeniedException'' - If there is any security problem: you can't modify the node because of lack of permissions. | ||
| + | * ''RepositoryException'' - If there is any general repository problem. | ||
| + | |||
| + | '''Since''' | ||
| + | * OpenKM 5.0 | ||
| + | |||
| + | == void remove(String token, int bmId) == | ||
| + | Remove a bookmark. | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''bmId'' - The bookmark id to be deleted. | ||
| + | |||
| + | '''Returns''' | ||
| + | * None. | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''AccessDeniedException'' - If there is any security problem: you can't modify the node because of lack of permissions. | ||
| + | * ''RepositoryException'' - If there is any general repository problem. | ||
| + | |||
| + | '''Since''' | ||
| + | * OpenKM 5.0 | ||
| + | |||
| + | == Bookmark rename(String token, int bmId, String newName) == | ||
| + | Rename a previous stored bookmark. | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''bmId'' - The bookmark id to be deleted. | ||
| + | * ''newName'' - The new bookmark name. | ||
| + | |||
| + | '''Returns''' | ||
| + | * The update bookmark properties. | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''AccessDeniedException'' - If there is any security problem: you can't modify the node because of lack of permissions. | ||
| + | * ''RepositoryException'' - If there is any general repository problem. | ||
| + | |||
| + | '''Since''' | ||
| + | * OpenKM 5.0 | ||
| + | |||
| + | == Bookmark[] getAll(String token) == | ||
| + | Retrieve a users bookmark collection | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | |||
| + | '''Returns''' | ||
| + | * All the user bookmarks. | ||
| + | |||
| + | '''Throws''' | ||
* ''RepositoryException'' - If there is any general repository problem. | * ''RepositoryException'' - If there is any general repository problem. | ||
Latest revision as of 17:19, 22 September 2011
Contents
Methods related to bookmark management.
Bookmark add(String token, String nodePath, String name)
Add a new bookmark which points to this document.
Parameters
- token - The session authorization token.
- nodePath - A node path to be bookmarked.
- name - The name of the bookmark.
Returns
- A bookmark object with the new created bookmark properties.
Throws
- AccessDeniedException - If there is any security problem: you can't modify the node because of lack of permissions.
- PathNotFoundException - If the parent folder doesn't exist.
- RepositoryException - If there is any general repository problem.
Since
- OpenKM 5.0
Bookmark get(String token, int bmId)
Get info from a previously created bookmark.
Parameters
- token - The session authorization token.
- bmId - The unique bookmark id.
Returns
- The bookmark object.
Throws
- AccessDeniedException - If there is any security problem: you can't modify the node because of lack of permissions.
- RepositoryException - If there is any general repository problem.
Since
- OpenKM 5.0
void remove(String token, int bmId)
Remove a bookmark.
Parameters
- token - The session authorization token.
- bmId - The bookmark id to be deleted.
Returns
- None.
Throws
- AccessDeniedException - If there is any security problem: you can't modify the node because of lack of permissions.
- RepositoryException - If there is any general repository problem.
Since
- OpenKM 5.0
Bookmark rename(String token, int bmId, String newName)
Rename a previous stored bookmark.
Parameters
- token - The session authorization token.
- bmId - The bookmark id to be deleted.
- newName - The new bookmark name.
Returns
- The update bookmark properties.
Throws
- AccessDeniedException - If there is any security problem: you can't modify the node because of lack of permissions.
- RepositoryException - If there is any general repository problem.
Since
- OpenKM 5.0
Bookmark[] getAll(String token)
Retrieve a users bookmark collection
Parameters
- token - The session authorization token.
Returns
- All the user bookmarks.
Throws
- RepositoryException - If there is any general repository problem.
Since
- OpenKM 5.0
