OKMPropertyGroup (OpenKM Web Application 6.3.2 API)

java.lang.Object
- com.openkm.api.OKMPropertyGroup

All Implemented Interfaces:: PropertyGroupModule

public class OKMPropertyGroup
extends Object
implements PropertyGroupModule

Author:: pavila

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`static OKMPropertyGroup`	`getInstance()`
`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.
`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 nodePath, 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.
`void`	`setPropertiesSimple(String token, String nodeId, String grpName, Map<String,String> properties)`
`static void`	`setPropertySimple(String token, String nodeId, String propGroup, String propName, String propValue)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static OKMPropertyGroup getInstance()

addGroup
```
public void addGroup(String token,
                     String nodePath,
                     String grpName)
              throws NoSuchGroupException,
                     LockException,
                     PathNotFoundException,
                     AccessDeniedException,
                     RepositoryException,
                     DatabaseException,
                     ExtensionException,
                     AutomationException
```
Description copied from interface: PropertyGroupModule

Add a property group to a document.

Specified by:

addGroup in interface PropertyGroupModule

Parameters:

token - The session authorization token.

nodePath - 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

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

Description copied from interface: PropertyGroupModule

Removes a property group from a document.

Specified by:: removeGroup in interface PropertyGroupModule
Parameters:: token - The session authorization token.; nodePath - 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

getGroups

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

Description copied from interface: PropertyGroupModule

Get groups assigned to a document.

Specified by:: getGroups in interface PropertyGroupModule
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:: PathNotFoundException - If there is no document in this repository path.; RepositoryException - If there is any general repository problem.; IOException; ParseException; AccessDeniedException; DatabaseException

getAllGroups

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

Description copied from interface: PropertyGroupModule

Get all groups defined in the system.

Specified by:: getAllGroups in interface PropertyGroupModule
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

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

Description copied from interface: PropertyGroupModule

Get all properties defined in a document by group.

Specified by:: getProperties in interface PropertyGroupModule
Parameters:: token - The session authorization token.; nodePath - 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

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

Description copied from interface: PropertyGroupModule

Set group properties to a document.

Specified by:: setProperties in interface PropertyGroupModule
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

setPropertySimple

public static void setPropertySimple(String token,
                                     String nodeId,
                                     String propGroup,
                                     String propName,
                                     String propValue)
                              throws IOException,
                                     ParseException,
                                     NoSuchPropertyException,
                                     NoSuchGroupException,
                                     LockException,
                                     PathNotFoundException,
                                     AccessDeniedException,
                                     RepositoryException,
                                     DatabaseException,
                                     ExtensionException,
                                     AutomationException

Throws:: IOException; ParseException; NoSuchPropertyException; NoSuchGroupException; LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException

setPropertiesSimple

public void setPropertiesSimple(String token,
                                String nodeId,
                                String grpName,
                                Map<String,String> properties)
                         throws IOException,
                                ParseException,
                                NoSuchPropertyException,
                                NoSuchGroupException,
                                LockException,
                                PathNotFoundException,
                                AccessDeniedException,
                                RepositoryException,
                                DatabaseException,
                                ExtensionException,
                                AutomationException

Throws:: IOException; ParseException; NoSuchPropertyException; NoSuchGroupException; LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException

getPropertyGroupForm

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

Description copied from interface: PropertyGroupModule

Get all possible values which can have a property.

Specified by:: getPropertyGroupForm in interface PropertyGroupModule
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
```
public boolean hasGroup(String token,
                        String nodeId,
                        String grpName)
                 throws IOException,
                        ParseException,
                        AccessDeniedException,
                        PathNotFoundException,
                        RepositoryException,
                        DatabaseException
```
Description copied from interface: PropertyGroupModule

Test if a node has a property group assigned

Specified by:

hasGroup in interface PropertyGroupModule

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:

PathNotFoundException - If there is no document in this repository path.

RepositoryException - If there is any general repository problem.

IOException

ParseException

AccessDeniedException

DatabaseException

getSuggestions

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

Description copied from interface: PropertyGroupModule

Obtain suggestion from a property in a document

Specified by:: getSuggestions in interface PropertyGroupModule
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

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

Description copied from interface: PropertyGroupModule

Specified by:: registerDefinition in interface PropertyGroupModule
Parameters:: token - The session authorization token.; pgDef - The XML with the Property Group Definition
Throws:: ParseException; AccessDeniedException; DatabaseException; IOException

Class OKMPropertyGroup

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

addGroup

removeGroup

getGroups

getAllGroups

getProperties

setProperties

setPropertySimple

setPropertiesSimple

getPropertyGroupForm

hasGroup

getSuggestions

registerDefinition