Package com.openkm.sdk4j.impl

Class PropertyGroupImpl

java.lang.Object

com.openkm.sdk4j.impl.ClientImpl

com.openkm.sdk4j.impl.PropertyGroupImpl

All Implemented Interfaces:

BasePropertyGroup, Serializable

public class PropertyGroupImpl
extends ClientImpl
implements BasePropertyGroup, Serializable

PropertyGroupImpl

Author:

sochoa

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PropertyGroupImpl(String host)	PropertyGroupImpl

Method Summary

Modifier and Type	Method	Description
void	addGroup(String uuid, String grpName, Map<String,String> propertiesMap)	Add group.
List<PropertyGroup>	getAllGroups()	Gets all property groups.
PropertyGroup	getGroup(String grpName)	Gets group.
List<PropertyGroup>	getGroups(String uuid)	Gets groups.
List<PropertyGroup>	getGroupsByVersion(String uuid, String versionName)	Gets groups by version.
Map<String,String>	getProperties(String uuid, String grpName)	Gets properties.
Map<String,String>	getPropertiesByVersion(String uuid, String grpName, String versionName)	Gets properties by version.
List<FormElement>	getPropertiesByVersionForm(String uuid, String grpName, String versionName)	Gets properties by version form.
List<FormElement>	getPropertyGroupForm(String uuid, String grpName)	Gets property group form.
List<FormElement>	getPropertyGroupFormDefinition(String grpName)	Gets property group form.
List<FormElement>	getPropertyGroupFormDefinition(String uuid, String grpName)	Gets property group form.
String	getRegisteredDefinition()	Gets registered definition.
String	getSuggestBoxKeyValue(String grpName, String propertyName, String key)	Gets suggest box key value.
Map<String,String>	getSuggestBoxKeyValuesFiltered(String grpName, String propertyName, String filter)	Gets suggest box key values filtered.
List<String>	getSuggestions(String uuid, String grpName, String propName)	Gets property group suggestions.
boolean	hasGroup(String uuid, String grpName)	Has group boolean.
void	registerDefinition(InputStream is, String name)	Register definition.
void	removeGroup(String uuid, String grpName)	Remove group.
protected void	setAuthorizationToken(String authorizationToken)	setAuthenticationToken
void	setProperties(String uuid, String grpName, Map<String,String> properties)	Sets properties.
String	validateField(String value, String className, List<String> uuids)	Validate field string.

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl

getClient, getWebTarget, setAuthorizationHeader, setJsessionIdHeader

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PropertyGroupImpl

public PropertyGroupImpl(String host)

PropertyGroupImpl

Method Details

setAuthorizationToken

protected void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

addGroup

public void addGroup(String uuid,
 String grpName,
 Map<String,String> propertiesMap)
              throws NoSuchGroupException,
LockException,
PathNotFoundException,
AccessDeniedException,
RepositoryException,
DatabaseException,
ExtensionException,
AutomationException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Add group.

Specified by:

addGroup in interface BasePropertyGroup

Parameters:

uuid - the uuid

grpName - the grp name

propertiesMap - the properties map

Throws:

NoSuchGroupException - the no such group exception

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

removeGroup

public void removeGroup(String uuid,
 String grpName)
                 throws AccessDeniedException,
NoSuchGroupException,
LockException,
PathNotFoundException,
RepositoryException,
DatabaseException,
ExtensionException,
AutomationException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Remove group.

Specified by:

removeGroup in interface BasePropertyGroup

Parameters:

uuid - the uuid

grpName - the grp name

Throws:

AccessDeniedException - the access denied exception

NoSuchGroupException - the no such group exception

LockException - the lock exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getGroups

public List<PropertyGroup> getGroups(String uuid)
                              throws AccessDeniedException,
ParseException,
PathNotFoundException,
RepositoryException,
DatabaseException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Gets groups.

Specified by:

getGroups in interface BasePropertyGroup

Parameters:

uuid - the uuid

Returns:

the property groups

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getAllGroups

public List<PropertyGroup> getAllGroups()
                                 throws AccessDeniedException,
ParseException,
RepositoryException,
DatabaseException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Gets all property groups.

Specified by:

getAllGroups in interface BasePropertyGroup

Returns:

the all property groups

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getProperties

public Map<String,String> getProperties(String uuid,
 String grpName)
                                 throws ParseException,
NoSuchGroupException,
PathNotFoundException,
AccessDeniedException,
RepositoryException,
DatabaseException,
PluginNotFoundException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Gets properties.

Specified by:

getProperties in interface BasePropertyGroup

Parameters:

uuid - the uuid

grpName - the grp name

Returns:

the property group properties

Throws:

ParseException - the parse exception

NoSuchGroupException - the no such group exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PluginNotFoundException - the plugin not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getPropertiesByVersion

public Map<String,String> getPropertiesByVersion(String uuid,
 String grpName,
 String versionName)
                                          throws ParseException,
NoSuchGroupException,
PathNotFoundException,
AccessDeniedException,
RepositoryException,
DatabaseException,
PluginNotFoundException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Gets properties by version.

Specified by:

getPropertiesByVersion in interface BasePropertyGroup

Parameters:

uuid - the uuid

grpName - the grp name

versionName - the version name

Returns:

the property group properties by version

Throws:

ParseException - the parse exception

NoSuchGroupException - the no such group exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PluginNotFoundException - the plugin not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getPropertiesByVersionForm

public List<FormElement> getPropertiesByVersionForm(String uuid,
 String grpName,
 String versionName)
                                             throws ParseException,
NoSuchGroupException,
PathNotFoundException,
RepositoryException,
DatabaseException,
PluginNotFoundException,
UnknownException,
WebserviceException,
AccessDeniedException

Description copied from interface: BasePropertyGroup

Gets properties by version form.

Specified by:

getPropertiesByVersionForm in interface BasePropertyGroup

Parameters:

uuid - the uuid

grpName - the grp name

versionName - the version name

Returns:

the property group by version form

Throws:

ParseException - the parse exception

NoSuchGroupException - the no such group exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

PluginNotFoundException - the plugin not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

getPropertyGroupFormDefinition

public List<FormElement> getPropertyGroupFormDefinition(String grpName)
                                                 throws AccessDeniedException,
ParseException,
NoSuchGroupException,
PathNotFoundException,
RepositoryException,
DatabaseException,
PluginNotFoundException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Gets property group form.

Specified by:

getPropertyGroupFormDefinition in interface BasePropertyGroup

Parameters:

grpName - the grp name

Returns:

the property group form

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

NoSuchGroupException - the no such group exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

PluginNotFoundException - the plugin not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getPropertyGroupFormDefinition

public List<FormElement> getPropertyGroupFormDefinition(String uuid,
 String grpName)
                                                 throws ParseException,
NoSuchGroupException,
PathNotFoundException,
RepositoryException,
DatabaseException,
PluginNotFoundException,
UnknownException,
WebserviceException,
AccessDeniedException

Description copied from interface: BasePropertyGroup

Gets property group form.

Specified by:

getPropertyGroupFormDefinition in interface BasePropertyGroup

Parameters:

uuid - the uuid

grpName - the grp name

Returns:

the property group form

Throws:

ParseException - the parse exception

NoSuchGroupException - the no such group exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

PluginNotFoundException - the plugin not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

getPropertyGroupForm

public List<FormElement> getPropertyGroupForm(String uuid,
 String grpName)
                                       throws ParseException,
NoSuchGroupException,
PathNotFoundException,
RepositoryException,
DatabaseException,
PluginNotFoundException,
UnknownException,
WebserviceException,
AccessDeniedException

Description copied from interface: BasePropertyGroup

Gets property group form.

Specified by:

getPropertyGroupForm in interface BasePropertyGroup

Parameters:

uuid - the uuid

grpName - the grp name

Returns:

the property group form

Throws:

ParseException - the parse exception

NoSuchGroupException - the no such group exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

PluginNotFoundException - the plugin not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

setProperties

public void setProperties(String uuid,
 String grpName,
 Map<String,String> properties)
                   throws AccessDeniedException,
ParseException,
NoSuchPropertyException,
NoSuchGroupException,
LockException,
PathNotFoundException,
RepositoryException,
DatabaseException,
ExtensionException,
AutomationException,
PluginNotFoundException,
ValidationFormException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Sets properties.

Specified by:

setProperties in interface BasePropertyGroup

Parameters:

uuid - the uuid

grpName - the grp name

properties - the properties

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

NoSuchPropertyException - the no such property exception

NoSuchGroupException - the no such group exception

LockException - the lock exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

PluginNotFoundException - the plugin not found exception

ValidationFormException - the validation form exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

hasGroup

public boolean hasGroup(String uuid,
 String grpName)
                 throws AccessDeniedException,
ParseException,
PathNotFoundException,
RepositoryException,
DatabaseException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Has group boolean.

Specified by:

hasGroup in interface BasePropertyGroup

Parameters:

uuid - the uuid

grpName - the grp name

Returns:

the boolean

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getGroupsByVersion

public List<PropertyGroup> getGroupsByVersion(String uuid,
 String versionName)
                                       throws AccessDeniedException,
ParseException,
PathNotFoundException,
RepositoryException,
DatabaseException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Gets groups by version.

Specified by:

getGroupsByVersion in interface BasePropertyGroup

Parameters:

uuid - the uuid

versionName - the version name

Returns:

the property groups by version

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getRegisteredDefinition

public String getRegisteredDefinition()
                               throws AccessDeniedException,
ParseException,
DatabaseException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Gets registered definition.

Specified by:

getRegisteredDefinition in interface BasePropertyGroup

Returns:

the registered property group definition

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getSuggestions

public List<String> getSuggestions(String uuid,
 String grpName,
 String propName)
                            throws AccessDeniedException,
PathNotFoundException,
ParseException,
NoSuchGroupException,
SuggestionException,
DatabaseException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Gets property group suggestions.

Specified by:

getSuggestions in interface BasePropertyGroup

Parameters:

uuid - the uuid

grpName - the grp name

propName - the prop name

Returns:

the property group suggestions

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

ParseException - the parse exception

NoSuchGroupException - the no such group exception

SuggestionException - the suggestion exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

registerDefinition

public void registerDefinition(InputStream is,
 String name)
                        throws AccessDeniedException,
ParseException,
DatabaseException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Register definition.

Specified by:

registerDefinition in interface BasePropertyGroup

Parameters:

is - the is

name - the name

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getGroup

public PropertyGroup getGroup(String grpName)
                       throws AccessDeniedException,
ParseException,
RepositoryException,
DatabaseException,
NoSuchGroupException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Gets group.

Specified by:

getGroup in interface BasePropertyGroup

Parameters:

grpName - the grp name

Returns:

the property group

Throws:

AccessDeniedException - the access denied exception

ParseException - the parse exception

RepositoryException - the repository exception

DatabaseException - the database exception

NoSuchGroupException - the no such group exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getSuggestBoxKeyValue

public String getSuggestBoxKeyValue(String grpName,
 String propertyName,
 String key)
                             throws ParseException,
AccessDeniedException,
DatabaseException,
PluginNotFoundException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Gets suggest box key value.

Specified by:

getSuggestBoxKeyValue in interface BasePropertyGroup

Parameters:

grpName - the grp name

propertyName - the property name

key - the key

Returns:

the suggest box key value

Throws:

ParseException - the parse exception

AccessDeniedException - the access denied exception

DatabaseException - the database exception

PluginNotFoundException - the plugin not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getSuggestBoxKeyValuesFiltered

public Map<String,String> getSuggestBoxKeyValuesFiltered(String grpName,
 String propertyName,
 String filter)
                                                  throws ParseException,
AccessDeniedException,
DatabaseException,
PluginNotFoundException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Gets suggest box key values filtered.

Specified by:

getSuggestBoxKeyValuesFiltered in interface BasePropertyGroup

Parameters:

grpName - the grp name

propertyName - the property name

filter - the filter

Returns:

the suggest box key values filtered

Throws:

ParseException - the parse exception

AccessDeniedException - the access denied exception

DatabaseException - the database exception

PluginNotFoundException - the plugin not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

validateField

public String validateField(String value,
 String className,
 List<String> uuids)
                     throws PluginNotFoundException,
UnknownException,
WebserviceException

Description copied from interface: BasePropertyGroup

Validate field string.

Specified by:

validateField in interface BasePropertyGroup

Parameters:

value - the value

className - the class name

uuids - the uuids

Returns:

the string

Throws:

PluginNotFoundException - the plugin not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception