Difference between revisions of "OKMPropertyGroup"
From OpenKM Documentation
(→PropertyGroup[] getGroups(String token, String nodePath)) |
(→PropertyGroup[] getAllGroups(String token)) |
||
| Line 64: | Line 64: | ||
== PropertyGroup[] getAllGroups(String token) == | == PropertyGroup[] getAllGroups(String token) == | ||
| + | Get all groups defined in the system. | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' The session authorization token. | ||
| + | |||
| + | '''Returns''' | ||
| + | * A list with all groups registered in the system. | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''RepositoryException'' If there is any general repository problem. | ||
| + | |||
| + | '''Since''' | ||
| + | * OpenKM 4.1 | ||
== FormElement[] getProperties(String token, String nodePath, String grpName) == | == FormElement[] getProperties(String token, String nodePath, String grpName) == | ||
Revision as of 11:00, 21 October 2010
Contents
- 1 void addGroup(String token, String nodePath, String grpName)
- 2 void removeGroup(String token, String nodePath, String grpName)
- 3 PropertyGroup[] getGroups(String token, String nodePath)
- 4 PropertyGroup[] getAllGroups(String token)
- 5 FormElement[] getProperties(String token, String nodePath, String grpName)
- 6 void setProperties(String token, String nodePath, String grpName, FormElement[] properties)
- 7 boolean hasGroup(String token, String nodePath, String grpName)
Methods related to Property Groups.
void addGroup(String token, String nodePath, String grpName)
Add a property group to a document.
Parameters
- token The session authorization token.
- nodePath The path that identifies an unique node.
- grpName The group name previously registered in the system.
Returns
- None.
Throws
- NoSuchGroupException If there is no such registered group name.
- LockException Can't modify 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.
Since
- OpenKM 4.1
void removeGroup(String token, String nodePath, String grpName)
Removes a property group from a document.
Parameters
- token The session authorization token.
- nodePath The path that identifies an unique node.
- grpName The group name previously registered in the system.
Returns
- None.
Throws
- NoSuchGroupException If there is no such registered group name.
- LockException Can't modify a locked document.
- PathNotFoundException If there is no document in this repository path.
- RepositoryException If there is any general repository problem.
Since
- OpenKM 4.1
PropertyGroup[] getGroups(String token, String nodePath)
Get groups assigned to a document.
Parameters
- token The session authorization token.
- nodePath The path that identifies an unique node.
Returns
- A list with all groups assigned to the document.
Throws
- NoSuchGroupException If there is no such registered group name.
- LockException Can't modify a locked document.
- PathNotFoundException If there is no document in this repository path.
- RepositoryException If there is any general repository problem.
Since
- OpenKM 4.1
PropertyGroup[] getAllGroups(String token)
Get all groups defined in the system.
Parameters
- token The session authorization token.
Returns
- A list with all groups registered in the system.
Throws
- RepositoryException If there is any general repository problem.
Since
- OpenKM 4.1
