Package com.openkm.sdk4j.definition

Interface BasePropertyGroup

All Known Implementing Classes:

PropertyGroupImpl

public interface BasePropertyGroup

BasePropertyGroup

Author:

sochoa

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.
List<PropertyGroup>	getAllGroups(String uuid)	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.
void	setProperties(String uuid, String grpName, Map<String,String> properties)	Sets properties.
String	validateField(String value, String className, List<String> uuids)	Validate field string.

Method Detail

addGroup

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

Add group.

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

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

Remove group.

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

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

Gets groups.

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

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

Gets all property groups.

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

getAllGroups

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

Gets all property groups.

Parameters:

uuid - the uuid

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

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

Gets properties.

Parameters:

uuid - the uuid

grpName - the grp name

Returns:

the property group 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

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

getPropertiesByVersion

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

Gets properties by version.

Parameters:

uuid - the uuid

grpName - the grp name

versionName - the version name

Returns:

the property group properties by version

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

getPropertiesByVersionForm

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

Gets properties by version form.

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

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

Gets property group form.

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

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

Gets property group form.

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

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

Gets property group form.

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

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

Sets properties.

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

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

Has group boolean.

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

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

Gets groups by version.

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

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

Gets registered definition.

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

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

Gets property group suggestions.

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

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

Register definition.

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

IOException

getGroup

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

Gets group.

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

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

Gets suggest box key value.

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

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

Gets suggest box key values filtered.

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

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

Validate field string.

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