Package org.odpi.openmetadata.viewservices.glossaryauthor.fvt.client.subjectAreaDefinitionCategory

Interface GlossaryAuthorViewSubjectAreaDefinitionCategory

All Known Implementing Classes:

GlossaryAuthorViewSubjectAreaDefinitionCategoryClient

public interface GlossaryAuthorViewSubjectAreaDefinitionCategory

Method Summary

Modifier and Type	Method	Description
SubjectAreaDefinition	create(String userId, SubjectAreaDefinition subjectAreaDefinition)	Create a subjectAreaDefinition.
void	delete(String userId, String guid)	Delete a SubjectAreaDefinition.
List<SubjectAreaDefinition>	find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Extract children within a SubjectAreaDefinition
List<SubjectAreaDefinition>	findAll(String userId)	Find Category
SubjectAreaDefinition	getByGUID(String userId, String guid)	Get a SubjectAreaDefinition.
List<Category>	getCategories(String userId, String subjectAreaDefinitionGuid, FindRequest findRequest)	Extract categories for a SubjectAreaDefinition
List<Category>	getCategoryChildren(String userId, String parentGuid, FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Extract children within a Category
OMAGServerConfig	getConfig(String userId)	Get config for server
ViewServiceConfig	getGlossaryAuthViewServiceConfig(String userId)	Get service config for a particular view Service
List<ViewServiceConfig>	getViewServiceConfigs(String userId)	Get list of view service config on the server
SubjectAreaDefinition	restore(String userId, String guid)	Restore a soft-deleted SubjectAreaDefinition.
SubjectAreaDefinition	update(String userId, String guid, SubjectAreaDefinition subjectAreaDefinition, boolean isReplace)	Update a SubjectAreaDefinition.

Method Detail

create

SubjectAreaDefinition create(String userId,
                             SubjectAreaDefinition subjectAreaDefinition)
                      throws PropertyServerException,
                             UserNotAuthorizedException,
                             InvalidParameterException

Create a subjectAreaDefinition.

The result is the subjectAreaDefinition object

Parameters:

userId - userId under which the request is performed

subjectAreaDefinition - SubjectAreaDefinition object to be created

Returns:

The SubjectAreaDefinition

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

getByGUID

SubjectAreaDefinition getByGUID(String userId,
                                String guid)
                         throws PropertyServerException,
                                UserNotAuthorizedException,
                                InvalidParameterException

Get a SubjectAreaDefinition.

The result is the requested SubjectAreaDefinition object

Parameters:

userId - userId under which the request is performed

guid - guid of SubjectAreaDefinition object to be retrieved

Returns:

The requested SubjectAreaDefinition

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

update

SubjectAreaDefinition update(String userId,
                             String guid,
                             SubjectAreaDefinition subjectAreaDefinition,
                             boolean isReplace)
                      throws PropertyServerException,
                             InvalidParameterException,
                             UserNotAuthorizedException

Update a SubjectAreaDefinition.

The result is the updated Glossary object

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be updated

subjectAreaDefinition - Glossary object with updated values

isReplace - If the object is to be replaced

Returns:

The updated SubjectAreaDefinition

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

delete

void delete(String userId,
            String guid)
     throws PropertyServerException

Delete a SubjectAreaDefinition.

The result Void object

Parameters:

userId - userId under which the request is performed

guid - guid of SubjectAreaDefinition object to be retrieved

Throws:

PropertyServerException - something went wrong with the REST call stack.

restore

SubjectAreaDefinition restore(String userId,
                              String guid)
                       throws PropertyServerException,
                              UserNotAuthorizedException,
                              InvalidParameterException

Restore a soft-deleted SubjectAreaDefinition.

The result is the restored SubjectAreaDefinition object

Parameters:

userId - userId under which the request is performed

guid - guid of SubjectAreaDefinition object to be restored

Returns:

The restored SubjectAreaDefinition

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

getCategoryChildren

List<Category> getCategoryChildren(String userId,
                                   String parentGuid,
                                   FindRequest findRequest,
                                   boolean exactValue,
                                   boolean ignoreCase)
                            throws PropertyServerException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException

Extract children within a Category

Parameters:

userId - calling user

parentGuid - Category GUID

findRequest - information object for find calls. This include pageSize to limit the number of elements returned.

exactValue - exactValue - when false values with trailing characters will match.

ignoreCase - ignore the case when matching.

Returns:

list of Categories

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

findAll

List<SubjectAreaDefinition> findAll(String userId)
                             throws PropertyServerException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException

Find Category

Parameters:

userId - calling user

Returns:

Categories belonging to Userid

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

find

List<SubjectAreaDefinition> find(String userId,
                                 FindRequest findRequest,
                                 boolean exactValue,
                                 boolean ignoreCase)
                          throws PropertyServerException,
                                 UserNotAuthorizedException,
                                 InvalidParameterException

Extract children within a SubjectAreaDefinition

Parameters:

userId - calling user

findRequest - information object for find calls. This include pageSize to limit the number of elements returned.

exactValue - exactValue - when false values with trailing characters will match.

ignoreCase - ignore the case when matching.

Returns:

list of Categories

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

getCategories

List<Category> getCategories(String userId,
                             String subjectAreaDefinitionGuid,
                             FindRequest findRequest)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Extract categories for a SubjectAreaDefinition

Parameters:

userId - calling user

subjectAreaDefinitionGuid - RelationShip GUID

findRequest - information object for find calls. This include pageSize to limit the number of elements returned.

Returns:

list of Categories

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

getConfig

OMAGServerConfig getConfig(String userId)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Get config for server

Parameters:

userId - calling user

Returns:

Config for view server

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

getViewServiceConfigs

List<ViewServiceConfig> getViewServiceConfigs(String userId)
                                       throws InvalidParameterException,
                                              PropertyServerException,
                                              UserNotAuthorizedException

Get list of view service config on the server

Parameters:

userId - calling user

Returns:

Config for view server

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

getGlossaryAuthViewServiceConfig

ViewServiceConfig getGlossaryAuthViewServiceConfig(String userId)
                                            throws InvalidParameterException,
                                                   PropertyServerException,
                                                   UserNotAuthorizedException

Get service config for a particular view Service

Parameters:

userId - calling user

Returns:

Config for view server

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid