public interface PropertyGroupModule
Modifier and Type | Method and Description |
---|---|
void |
addGroup(String token,
String nodePath,
String grpName)
Add a property group to a document.
|
List<PropertyGroup> |
getAllGroups(String token)
Get all groups defined in the system.
|
List<PropertyGroup> |
getGroups(String token,
String nodePath)
Get groups assigned to a document.
|
List<FormElement> |
getProperties(String token,
String nodePath,
String grpName)
Get all properties defined in a document by group.
|
List<FormElement> |
getPropertyGroupForm(String token,
String grpName)
Get all possible values which can have a property.
|
boolean |
hasGroup(String token,
String nodePath,
String grpName)
Test if a node has a property group assigned
|
void |
removeGroup(String token,
String nodePath,
String grpName)
Removes a property group from a document.
|
void |
setProperties(String token,
String nodePath,
String grpName,
List<FormElement> properties)
Set group properties to a document.
|
void addGroup(String token, String nodePath, String grpName) throws NoSuchGroupException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException
token
- The session authorization token.nodePath
- The path that identifies an unique node.grpName
- The group name previously registered in the system.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.DatabaseException
ExtensionException
AutomationException
void removeGroup(String token, String nodePath, String grpName) throws AccessDeniedException, NoSuchGroupException, LockException, PathNotFoundException, RepositoryException, DatabaseException, ExtensionException
token
- The session authorization token.nodePath
- The path that identifies an unique node.grpName
- The group name previously registered in the system.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.AccessDeniedException
DatabaseException
ExtensionException
List<PropertyGroup> getGroups(String token, String nodePath) throws IOException, ParseException, PathNotFoundException, RepositoryException, DatabaseException
token
- The session authorization token.nodePath
- The path that identifies an unique node.PathNotFoundException
- If there is no document in this
repository path.RepositoryException
- If there is any general repository problem.IOException
ParseException
DatabaseException
List<PropertyGroup> getAllGroups(String token) throws IOException, ParseException, RepositoryException, DatabaseException
token
- The session authorization token.RepositoryException
- If there is any general repository problem.IOException
ParseException
DatabaseException
List<FormElement> getProperties(String token, String nodePath, String grpName) throws IOException, ParseException, NoSuchGroupException, PathNotFoundException, RepositoryException, DatabaseException
token
- The session authorization token.nodePath
- The path that identifies an unique node.grpName
- The group name previously registered in the system.NoSuchGroupException
- If there is no such registered group name.PathNotFoundException
- If there is no document in this
repository path.RepositoryException
- If there is any general repository problem.IOException
ParseException
DatabaseException
void setProperties(String token, String nodePath, String grpName, List<FormElement> properties) throws IOException, ParseException, NoSuchPropertyException, NoSuchGroupException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException
token
- The session authorization token.nodePath
- The path that identifies an unique node.grpName
- The group name previously registered in the system.properties
- The property values.NoSuchPropertyException
- If there is no such registered category property.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.IOException
ParseException
DatabaseException
ExtensionException
AutomationException
List<FormElement> getPropertyGroupForm(String token, String grpName) throws ParseException, IOException, RepositoryException, DatabaseException
token
- The session authorization token.grpName
- The group name previously registered in the system.IOException
- If there is any problem reading the property values.RepositoryException
- If there is any general repository problem.ParseException
DatabaseException
boolean hasGroup(String token, String nodePath, String grpName) throws IOException, ParseException, PathNotFoundException, RepositoryException, DatabaseException
token
- The session authorization token.nodePath
- The path that identifies an unique node.grpName
- The group name previously registered in the system.NoSuchGroupException
- If there is no such registered group name.PathNotFoundException
- If there is no document in this
repository path.RepositoryException
- If there is any general repository problem.IOException
ParseException
DatabaseException
Copyright © 2015. All Rights Reserved.