Difference between revisions of "OKMProperty"

From OpenKM Documentation
Jump to: navigation, search
(void removeCategory(String token, String nodePath, String catId))
Line 29: Line 29:
 
* ''nodePath'' - A mail object with the new mail properties.
 
* ''nodePath'' - A mail object with the new mail properties.
 
* ''catId'' - Category id (the UUID of the category node).
 
* ''catId'' - Category id (the UUID of the category node).
 +
 +
'''Returns'''
 +
* None
 +
 +
'''Throws'''
 +
* ''PathNotFoundException'' - If the parent folder doesn't exist.
 +
* ''AccessDeniedException'' - If there is any security problem: you can't modify the parent folder because of lack of permissions.
 +
* ''RepositoryException'' - If there is any general repository problem.
 +
 +
'''Since'''
 +
* OpenKM 5.0
 +
 +
== void addKeyword(String token, String nodePath, String keyword) ==
 +
Remove a previously category from a document.
 +
 +
'''Parameters'''
 +
* ''token'' - The session authorization token.
 +
* ''nodePath'' - A mail object with the new mail properties.
 +
* ''keyword'' - The keyword to be added.
 +
 +
'''Returns'''
 +
* None
 +
 +
'''Throws'''
 +
* ''PathNotFoundException'' - If the parent folder doesn't exist.
 +
* ''AccessDeniedException'' - If there is any security problem: you can't modify the parent folder because of lack of permissions.
 +
* ''RepositoryException'' - If there is any general repository problem.
 +
 +
'''Since'''
 +
* OpenKM 5.0
 +
 +
== void removeKeyword(String token, String nodePath, String keyword) ==
 +
Remove a previously assigned keyword from a document.
 +
 +
'''Parameters'''
 +
* ''token'' - The session authorization token.
 +
* ''nodePath'' - A mail object with the new mail properties.
 +
* ''keyword'' - The keyword to be added.
  
 
'''Returns'''
 
'''Returns'''

Revision as of 10:58, 26 October 2010

Methods related to document properties management.

void addCategory(String token, String nodePath, String catId)

Add a new category to document.

Parameters

  • token - The session authorization token.
  • nodePath - A mail object with the new mail properties.
  • catId - Category id (the UUID of the category node).

Returns

  • None

Throws

  • PathNotFoundException - If the parent folder doesn't exist.
  • AccessDeniedException - If there is any security problem: you can't modify the parent folder because of lack of permissions.
  • RepositoryException - If there is any general repository problem.

Since

  • OpenKM 5.0

void removeCategory(String token, String nodePath, String catId)

Remove a previously category from a document.

Parameters

  • token - The session authorization token.
  • nodePath - A mail object with the new mail properties.
  • catId - Category id (the UUID of the category node).

Returns

  • None

Throws

  • PathNotFoundException - If the parent folder doesn't exist.
  • AccessDeniedException - If there is any security problem: you can't modify the parent folder because of lack of permissions.
  • RepositoryException - If there is any general repository problem.

Since

  • OpenKM 5.0

void addKeyword(String token, String nodePath, String keyword)

Remove a previously category from a document.

Parameters

  • token - The session authorization token.
  • nodePath - A mail object with the new mail properties.
  • keyword - The keyword to be added.

Returns

  • None

Throws

  • PathNotFoundException - If the parent folder doesn't exist.
  • AccessDeniedException - If there is any security problem: you can't modify the parent folder because of lack of permissions.
  • RepositoryException - If there is any general repository problem.

Since

  • OpenKM 5.0

void removeKeyword(String token, String nodePath, String keyword)

Remove a previously assigned keyword from a document.

Parameters

  • token - The session authorization token.
  • nodePath - A mail object with the new mail properties.
  • keyword - The keyword to be added.

Returns

  • None

Throws

  • PathNotFoundException - If the parent folder doesn't exist.
  • AccessDeniedException - If there is any security problem: you can't modify the parent folder because of lack of permissions.
  • RepositoryException - If there is any general repository problem.

Since

  • OpenKM 5.0