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

Class GlossaryAuthorViewSubjectAreaDefinitionCategoryClient

java.lang.Object

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

All Implemented Interfaces:

ResponseParameterization<SubjectAreaDefinition>, GlossaryAuthorViewSubjectAreaDefinitionCategory

public class GlossaryAuthorViewSubjectAreaDefinitionCategoryClient
extends Object
implements GlossaryAuthorViewSubjectAreaDefinitionCategory, ResponseParameterization<SubjectAreaDefinition>

The class acts as a wrapper class for calling the REST services for Glossary Author SubjectAreaDefinition related services.

Field Summary

Fields

Modifier and Type	Field	Description
protected final GlossaryAuthorViewRestClient	client

Constructor Summary

Constructors

Constructor	Description
GlossaryAuthorViewSubjectAreaDefinitionCategoryClient(GlossaryAuthorViewRestClient client)

Method Summary

Modifier and Type	Method	Description
SubjectAreaDefinition	create(String userId, SubjectAreaDefinition subjectAreaDefinition)	Create a subjectAreaDefinition.
<T> T	createRel(String userId, T t, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType)
Synonym	createSynonym(String userId, Synonym synonym)
void	delete(String userId, String guid)	Delete a SubjectAreaDefinition.
<T> void	deleteRel(String userId, String guid, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType)
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 termGuid, 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
protected String	getMethodInfo(String methodName)
<T> T	getRel(String userId, String guid, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType)
Synonym	getSynonym(String userId, String guid)
List<ViewServiceConfig>	getViewServiceConfigs(String userId)	Get list of view service config on the server
<T> T	replaceRel(String userId, String guid, T t, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType, boolean isReplace)
Class<? extends GenericResponse>	responseType()
SubjectAreaDefinition	restore(String userId, String guid)	Restore a soft-deleted SubjectAreaDefinition.
<T> T	restoreRel(String userId, String guid, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType)
SubjectAreaDefinition	update(String userId, String guid, SubjectAreaDefinition subjectAreaDefinition, boolean isReplace)	Update a SubjectAreaDefinition.
<T> T	updateRel(String userId, String guid, T t, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType, boolean isReplace)
Synonym	updateSynonym(String userId, String guid, Synonym updateSynonym, boolean isReplace)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.odpi.openmetadata.commonservices.ffdc.rest.ResponseParameterization

getParameterizedType, resultType

Field Details

client

protected final GlossaryAuthorViewRestClient client

Constructor Details

GlossaryAuthorViewSubjectAreaDefinitionCategoryClient

public GlossaryAuthorViewSubjectAreaDefinitionCategoryClient(GlossaryAuthorViewRestClient client)

Method Details

getMethodInfo

protected String getMethodInfo(String methodName)

create

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

Description copied from interface: GlossaryAuthorViewSubjectAreaDefinitionCategory

Create a subjectAreaDefinition.

The result is the subjectAreaDefinition object

Specified by:

create in interface GlossaryAuthorViewSubjectAreaDefinitionCategory

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.

InvalidParameterException - one of the parameters is null or invalid

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

update

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

Description copied from interface: GlossaryAuthorViewSubjectAreaDefinitionCategory

Update a SubjectAreaDefinition.

The result is the updated Glossary object

Specified by:

update in interface GlossaryAuthorViewSubjectAreaDefinitionCategory

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.

InvalidParameterException - one of the parameters is null or invalid

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

delete

public void delete(String userId,
 String guid)
            throws PropertyServerException

Description copied from interface: GlossaryAuthorViewSubjectAreaDefinitionCategory

Delete a SubjectAreaDefinition.

The result Void object

Specified by:

delete in interface GlossaryAuthorViewSubjectAreaDefinitionCategory

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

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

Description copied from interface: GlossaryAuthorViewSubjectAreaDefinitionCategory

Restore a soft-deleted SubjectAreaDefinition.

The result is the restored SubjectAreaDefinition object

Specified by:

restore in interface GlossaryAuthorViewSubjectAreaDefinitionCategory

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.

InvalidParameterException - one of the parameters is null or invalid

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

getCategoryChildren

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

Description copied from interface: GlossaryAuthorViewSubjectAreaDefinitionCategory

Extract children within a Category

Specified by:

getCategoryChildren in interface GlossaryAuthorViewSubjectAreaDefinitionCategory

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:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - something went wrong with the REST call stack.

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

findAll

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

Description copied from interface: GlossaryAuthorViewSubjectAreaDefinitionCategory

Find Category

Specified by:

findAll in interface GlossaryAuthorViewSubjectAreaDefinitionCategory

Parameters:

userId - calling user

Returns:

Categories belonging to Userid

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - something went wrong with the REST call stack.

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

getByGUID

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

Description copied from interface: GlossaryAuthorViewSubjectAreaDefinitionCategory

Get a SubjectAreaDefinition.

The result is the requested SubjectAreaDefinition object

Specified by:

getByGUID in interface GlossaryAuthorViewSubjectAreaDefinitionCategory

Parameters:

userId - userId under which the request is performed

guid - guid of SubjectAreaDefinition object to be retrieved

Returns:

The requested SubjectAreaDefinition

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - something went wrong with the REST call stack.

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

find

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

Description copied from interface: GlossaryAuthorViewSubjectAreaDefinitionCategory

Extract children within a SubjectAreaDefinition

Specified by:

find in interface GlossaryAuthorViewSubjectAreaDefinitionCategory

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:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - something went wrong with the REST call stack.

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

getCategories

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

Description copied from interface: GlossaryAuthorViewSubjectAreaDefinitionCategory

Extract categories for a SubjectAreaDefinition

Specified by:

getCategories in interface GlossaryAuthorViewSubjectAreaDefinitionCategory

Parameters:

userId - calling user

termGuid - RelationShip GUID

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

Returns:

list of Categories

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - something went wrong with the REST call stack.

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

getConfig

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

Description copied from interface: GlossaryAuthorViewSubjectAreaDefinitionCategory

Get config for server

Specified by:

getConfig in interface GlossaryAuthorViewSubjectAreaDefinitionCategory

Parameters:

userId - calling user

Returns:

Config for view server

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - something went wrong with the REST call stack.

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

getGlossaryAuthViewServiceConfig

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

Description copied from interface: GlossaryAuthorViewSubjectAreaDefinitionCategory

Get service config for a particular view Service

Specified by:

getGlossaryAuthViewServiceConfig in interface GlossaryAuthorViewSubjectAreaDefinitionCategory

Parameters:

userId - calling user

Returns:

Config for view server

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - something went wrong with the REST call stack.

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

getViewServiceConfigs

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

Description copied from interface: GlossaryAuthorViewSubjectAreaDefinitionCategory

Get list of view service config on the server

Specified by:

getViewServiceConfigs in interface GlossaryAuthorViewSubjectAreaDefinitionCategory

Parameters:

userId - calling user

Returns:

Config for view server

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - something went wrong with the REST call stack.

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

responseType

public Class<? extends GenericResponse> responseType()

Specified by:

responseType in interface ResponseParameterization<SubjectAreaDefinition>

Returns:

the response class type inherited from GenericResponse

createSynonym

public Synonym createSynonym(String userId,
 Synonym synonym)
                      throws PropertyServerException,
InvalidParameterException,
UserNotAuthorizedException

Throws:

PropertyServerException

InvalidParameterException

UserNotAuthorizedException

getSynonym

public Synonym getSynonym(String userId,
 String guid)
                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Throws:

InvalidParameterException

PropertyServerException

UserNotAuthorizedException

updateSynonym

public Synonym updateSynonym(String userId,
 String guid,
 Synonym updateSynonym,
 boolean isReplace)
                      throws PropertyServerException,
InvalidParameterException,
UserNotAuthorizedException

Throws:

PropertyServerException

InvalidParameterException

UserNotAuthorizedException

createRel

public <T> T createRel(String userId,
 T t,
 org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type,
 String relType)
                throws PropertyServerException,
InvalidParameterException,
UserNotAuthorizedException

Throws:

PropertyServerException

InvalidParameterException

UserNotAuthorizedException

getRel

public <T> T getRel(String userId,
 String guid,
 org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type,
 String relType)
             throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Throws:

InvalidParameterException

PropertyServerException

UserNotAuthorizedException

updateRel

public <T> T updateRel(String userId,
 String guid,
 T t,
 org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type,
 String relType,
 boolean isReplace)
                throws PropertyServerException,
InvalidParameterException,
UserNotAuthorizedException

Throws:

PropertyServerException

InvalidParameterException

UserNotAuthorizedException

replaceRel

public <T> T replaceRel(String userId,
 String guid,
 T t,
 org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type,
 String relType,
 boolean isReplace)
                 throws PropertyServerException,
InvalidParameterException,
UserNotAuthorizedException

Throws:

PropertyServerException

InvalidParameterException

UserNotAuthorizedException

deleteRel

public <T> void deleteRel(String userId,
 String guid,
 org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type,
 String relType)
                   throws PropertyServerException

Throws:

PropertyServerException

restoreRel

public <T> T restoreRel(String userId,
 String guid,
 org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type,
 String relType)
                 throws PropertyServerException,
InvalidParameterException,
UserNotAuthorizedException

Throws:

PropertyServerException

InvalidParameterException

UserNotAuthorizedException