PropertyGroupModule (OpenKM Web Application 6.3.6 API)

All Known Implementing Classes:

DbPropertyGroupModule, OKMPropertyGroup
```
public interface PropertyGroupModule
```

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addGroup(String token, String nodeId, 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 nodeId)` Get groups assigned to a document.
`List<FormElement>`	`getProperties(String token, String nodeId, 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.
`List<String>`	`getSuggestions(String token, String nodeId, String grpName, String propName)` Obtain suggestion from a property in a document
`boolean`	`hasGroup(String token, String nodeId, String grpName)` Test if a node has a property group assigned
`void`	`registerDefinition(String token, String pgDef)` Register Property Group definition.
`void`	`removeGroup(String token, String nodeId, String grpName)` Removes a property group from a document.
`void`	`setProperties(String token, String nodeId, String grpName, List<FormElement> properties)` Set group properties to a document.

Method Detail

addGroup
```
void addGroup(String token,
            String nodeId,
            String grpName)
              throws NoSuchGroupException,
                     LockException,
                     PathNotFoundException,
                     AccessDeniedException,
                     RepositoryException,
                     DatabaseException,
                     ExtensionException,
                     AutomationException
```
Add a property group to a document.

Parameters:
token - The session authorization token.
nodeId - The path that identifies an unique node.
grpName - The group name previously registered in the system.

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.

DatabaseException

ExtensionException

AutomationException

removeGroup

void removeGroup(String token,
               String nodeId,
               String grpName)
                 throws AccessDeniedException,
                        NoSuchGroupException,
                        LockException,
                        PathNotFoundException,
                        RepositoryException,
                        DatabaseException,
                        ExtensionException,
                        AutomationException

Removes a property group from a document.

Parameters:: token - The session authorization token.; nodeId - The path that identifies an unique node.; grpName - The group name previously registered in the system.
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.; AccessDeniedException; DatabaseException; ExtensionException; AutomationException

getGroups

List<PropertyGroup> getGroups(String token,
                            String nodeId)
                              throws IOException,
                                     ParseException,
                                     AccessDeniedException,
                                     PathNotFoundException,
                                     RepositoryException,
                                     DatabaseException

Get groups assigned to a document.

Parameters:: token - The session authorization token.; nodeId - The path that identifies an unique node.
Returns:: A list with all groups assigned to the document.
Throws:: PathNotFoundException - If there is no document in this repository path.; RepositoryException - If there is any general repository problem.; IOException; ParseException; AccessDeniedException; DatabaseException

getAllGroups

List<PropertyGroup> getAllGroups(String token)
                                 throws IOException,
                                        ParseException,
                                        AccessDeniedException,
                                        RepositoryException,
                                        DatabaseException

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.; IOException; ParseException; AccessDeniedException; DatabaseException

getProperties

List<FormElement> getProperties(String token,
                              String nodeId,
                              String grpName)
                                throws IOException,
                                       ParseException,
                                       NoSuchGroupException,
                                       AccessDeniedException,
                                       PathNotFoundException,
                                       RepositoryException,
                                       DatabaseException

Get all properties defined in a document by group.

Parameters:: token - The session authorization token.; nodeId - The path that identifies an unique node.; grpName - The group name previously registered in the system.
Returns:: A list with all properties defined in the group and its actual values.
Throws:: 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; AccessDeniedException; DatabaseException

setProperties

void setProperties(String token,
                 String nodeId,
                 String grpName,
                 List<FormElement> properties)
                   throws IOException,
                          ParseException,
                          NoSuchPropertyException,
                          NoSuchGroupException,
                          LockException,
                          PathNotFoundException,
                          AccessDeniedException,
                          RepositoryException,
                          DatabaseException,
                          ExtensionException,
                          AutomationException

Set group properties to a document.

Parameters:: token - The session authorization token.; nodeId - The path that identifies an unique node or its UUID.; grpName - The group name previously registered in the system.; properties - The property values.
Throws:: 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

getPropertyGroupForm

List<FormElement> getPropertyGroupForm(String token,
                                     String grpName)
                                       throws ParseException,
                                              IOException,
                                              AccessDeniedException,
                                              RepositoryException,
                                              DatabaseException

Get all possible values which can have a property.

Parameters:: token - The session authorization token.; grpName - The group name previously registered in the system.
Throws:: IOException - If there is any problem reading the property values.; RepositoryException - If there is any general repository problem.; ParseException; AccessDeniedException; DatabaseException

hasGroup
```
boolean hasGroup(String token,
               String nodeId,
               String grpName)
                 throws IOException,
                        ParseException,
                        AccessDeniedException,
                        PathNotFoundException,
                        RepositoryException,
                        DatabaseException
```
Test if a node has a property group assigned

Parameters:
token - The session authorization token.
nodeId - The path that identifies an unique node or its UUID.
grpName - The group name previously registered in the system.

Returns:
True if the document has the given property group assigned, and false otherwise.

Throws:

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

AccessDeniedException

DatabaseException

getSuggestions

List<String> getSuggestions(String token,
                          String nodeId,
                          String grpName,
                          String propName)
                            throws AccessDeniedException,
                                   PathNotFoundException,
                                   IOException,
                                   ParseException,
                                   NoSuchGroupException,
                                   SuggestionException,
                                   DatabaseException

Obtain suggestion from a property in a document

Parameters:: token - The session authorization token.; nodeId - The path that identifies an unique node or its UUID.; grpName - The group name previously registered in the system.; propName - The group name previously registered in the system.
Throws:: AccessDeniedException; PathNotFoundException; IOException; ParseException; NoSuchGroupException; SuggestionException; DatabaseException

registerDefinition

void registerDefinition(String token,
                      String pgDef)
                        throws ParseException,
                               AccessDeniedException,
                               DatabaseException,
                               IOException

Parameters:: token - The session authorization token.; pgDef - The XML with the Property Group Definition
Throws:: ParseException; AccessDeniedException; DatabaseException; IOException

Interface PropertyGroupModule