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:

jllort

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PropertyGroupImpl(String host) PropertyGroupImpl

Method Summary

Modifier and Type	Method and Description
void	addPropertyGroup(String uuid, String grpName, Map<String,String> propertiesMap) Add property group.
List<PropertyGroup>	getAllPropertyGroups() Gets all property groups.
PropertyGroup	getPropertyGroup(String grpName) Gets property group.
List<FormElement>	getPropertyGroupByVersionForm(String uuid, String grpName, String versionName) Gets property group by version form.
List<FormElement>	getPropertyGroupForm(String grpName) Gets property group form.
List<FormElement>	getPropertyGroupForm(String uuid, String grpName) Gets property group form.
Map<String,String>	getPropertyGroupProperties(String uuid, String grpName) Gets property group properties.
Map<String,String>	getPropertyGroupPropertiesByVersion(String uuid, String grpName, String versionName) Gets property group properties by version.
List<PropertyGroup>	getPropertyGroups(String uuid) Gets property groups.
List<PropertyGroup>	getPropertyGroupsByVersion(String uuid, String versionName) Gets property groups by version.
List<String>	getPropertyGroupSuggestions(String uuid, String grpName, String propName) Gets property group suggestions.
String	getRegisteredPropertyGroupDefinition() Gets registered property group 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.
boolean	hasPropertyGroup(String uuid, String grpName) Has property group boolean.
void	registerPropertyGroupDefinition(InputStream is, String name) Register property group definition.
void	removePropertyGroup(String uuid, String grpName) Remove property group.
void	setAuthorizationToken(String authorizationToken) setAuthenticationToken
void	setPropertyGroupProperties(String uuid, String grpName, Map<String,String> properties) Sets property group properties.
String	validateField(String value, String className, List<String> uuids) Validate field string.

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

getClient, resource, resource, resource

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyGroupImpl

public PropertyGroupImpl(String host)

PropertyGroupImpl

Method Detail

setAuthorizationToken

public void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

addPropertyGroup

public void addPropertyGroup(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 property group.

Specified by:

addPropertyGroup 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

removePropertyGroup

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

Description copied from interface: BasePropertyGroup

Remove property group.

Specified by:

removePropertyGroup 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

getPropertyGroups

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

Description copied from interface: BasePropertyGroup

Gets property groups.

Specified by:

getPropertyGroups in interface BasePropertyGroup

Parameters:

uuid - the uuid

Returns:

the property groups

Throws:

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

AccessDeniedException - the access denied exception

getAllPropertyGroups

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

Description copied from interface: BasePropertyGroup

Gets all property groups.

Specified by:

getAllPropertyGroups in interface BasePropertyGroup

Returns:

the all property groups

Throws:

ParseException - the parse exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

getPropertyGroupForm

public List<FormElement> getPropertyGroupForm(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:

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

setPropertyGroupProperties

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

Description copied from interface: BasePropertyGroup

Sets property group properties.

Specified by:

setPropertyGroupProperties in interface BasePropertyGroup

Parameters:

uuid - the uuid

grpName - the grp name

properties - the properties

Throws:

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

AccessDeniedException - the access denied 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

hasPropertyGroup

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

Description copied from interface: BasePropertyGroup

Has property group boolean.

Specified by:

hasPropertyGroup in interface BasePropertyGroup

Parameters:

uuid - the uuid

grpName - the grp name

Returns:

the boolean

Throws:

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

AccessDeniedException - the access denied exception

getPropertyGroupsByVersion

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

Description copied from interface: BasePropertyGroup

Gets property groups by version.

Specified by:

getPropertyGroupsByVersion in interface BasePropertyGroup

Parameters:

uuid - the uuid

versionName - the version name

Returns:

the property groups by version

Throws:

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

AccessDeniedException - the access denied exception

getRegisteredPropertyGroupDefinition

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

Description copied from interface: BasePropertyGroup

Gets registered property group definition.

Specified by:

getRegisteredPropertyGroupDefinition in interface BasePropertyGroup

Returns:

the registered property group definition

Throws:

ParseException - the parse exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

getPropertyGroupSuggestions

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

Description copied from interface: BasePropertyGroup

Gets property group suggestions.

Specified by:

getPropertyGroupSuggestions in interface BasePropertyGroup

Parameters:

uuid - the uuid

grpName - the grp name

propName - the prop name

Returns:

the property group suggestions

Throws:

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

AccessDeniedException - the access denied exception

registerPropertyGroupDefinition

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

Description copied from interface: BasePropertyGroup

Register property group definition.

Specified by:

registerPropertyGroupDefinition in interface BasePropertyGroup

Parameters:

is - the is

name - the name

Throws:

ParseException - the parse exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

AccessDeniedException - the access denied exception

getPropertyGroupProperties

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

Description copied from interface: BasePropertyGroup

Gets property group properties.

Specified by:

getPropertyGroupProperties 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

getPropertyGroupPropertiesByVersion

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

Description copied from interface: BasePropertyGroup

Gets property group properties by version.

Specified by:

getPropertyGroupPropertiesByVersion 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

getPropertyGroupByVersionForm

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

Description copied from interface: BasePropertyGroup

Gets property group by version form.

Specified by:

getPropertyGroupByVersionForm 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

getPropertyGroup

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

Description copied from interface: BasePropertyGroup

Gets property group.

Specified by:

getPropertyGroup in interface BasePropertyGroup

Parameters:

grpName - the grp name

Returns:

the property group

Throws:

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

AccessDeniedException - the access denied 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