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

Class GlossaryAuthorViewRelationshipsClient

java.lang.Object

org.odpi.openmetadata.viewservices.glossaryauthor.fvt.client.relationships.GlossaryAuthorViewRelationshipsClient

All Implemented Interfaces:

ResponseParameterization<Relationship>, GlossaryAuthorViewRelationships

public class GlossaryAuthorViewRelationshipsClient
extends Object
implements GlossaryAuthorViewRelationships, ResponseParameterization<Relationship>

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final GlossaryAuthorViewRestClient	client

Constructor Summary

Constructors

Constructor	Description
GlossaryAuthorViewRelationshipsClient(GlossaryAuthorViewRestClient client)

Method Summary

Modifier and Type	Method	Description
Relationship	create(String userId, Relationship relationship)	Create a Relationship.
<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 Relationship.
<T> void	deleteRel(String userId, String guid, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType)
List<Relationship>	find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Extract children within a Relationship
List<Relationship>	findAll(String userId)	Find Category
Relationship	getByGUID(String userId, String guid)	Get a Relationship.
List<Category>	getCategories(String userId, String termGuid, FindRequest findRequest)	Extract categories for a Relationship
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()
Relationship	restore(String userId, String guid)	Restore a soft-deleted Relationship.
<T> T	restoreRel(String userId, String guid, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, String relType)
Relationship	update(String userId, String guid, Relationship relationship, boolean isReplace)	Update a Relationship.
<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

GlossaryAuthorViewRelationshipsClient

public GlossaryAuthorViewRelationshipsClient(GlossaryAuthorViewRestClient client)

Method Details

getMethodInfo

protected String getMethodInfo(String methodName)

create

public Relationship create(String userId,
 Relationship relationship)
                    throws PropertyServerException,
InvalidParameterException,
UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewRelationships

Create a Relationship.

The result is the Relationship object

Specified by:

create in interface GlossaryAuthorViewRelationships

Parameters:

userId - userId under which the request is performed

relationship - Relationship object to be created

Returns:

The Relationship

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 Relationship update(String userId,
 String guid,
 Relationship relationship,
 boolean isReplace)
                    throws PropertyServerException,
InvalidParameterException,
UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewRelationships

Update a Relationship.

The result is the updated Glossary object

Specified by:

update in interface GlossaryAuthorViewRelationships

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be updated

relationship - Glossary object with updated values

isReplace - If the object is to be replaced

Returns:

The updated Relationship

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: GlossaryAuthorViewRelationships

Delete a Relationship.

The result Void object

Specified by:

delete in interface GlossaryAuthorViewRelationships

Parameters:

userId - userId under which the request is performed

guid - guid of Relationship object to be retrieved

Throws:

PropertyServerException - something went wrong with the REST call stack.

restore

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

Description copied from interface: GlossaryAuthorViewRelationships

Restore a soft-deleted Relationship.

The result is the restored Relationship object

Specified by:

restore in interface GlossaryAuthorViewRelationships

Parameters:

userId - userId under which the request is performed

guid - guid of Relationship object to be restored

Returns:

The restored Relationship

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: GlossaryAuthorViewRelationships

Extract children within a Category

Specified by:

getCategoryChildren in interface GlossaryAuthorViewRelationships

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<Relationship> findAll(String userId)
                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewRelationships

Find Category

Specified by:

findAll in interface GlossaryAuthorViewRelationships

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 Relationship getByGUID(String userId,
 String guid)
                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewRelationships

Get a Relationship.

The result is the requested Relationship object

Specified by:

getByGUID in interface GlossaryAuthorViewRelationships

Parameters:

userId - userId under which the request is performed

guid - guid of Relationship object to be retrieved

Returns:

The requested Relationship

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<Relationship> find(String userId,
 FindRequest findRequest,
 boolean exactValue,
 boolean ignoreCase)
                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewRelationships

Extract children within a Relationship

Specified by:

find in interface GlossaryAuthorViewRelationships

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: GlossaryAuthorViewRelationships

Extract categories for a Relationship

Specified by:

getCategories in interface GlossaryAuthorViewRelationships

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: GlossaryAuthorViewRelationships

Get config for server

Specified by:

getConfig in interface GlossaryAuthorViewRelationships

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: GlossaryAuthorViewRelationships

Get service config for a particular view Service

Specified by:

getGlossaryAuthViewServiceConfig in interface GlossaryAuthorViewRelationships

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: GlossaryAuthorViewRelationships

Get list of view service config on the server

Specified by:

getViewServiceConfigs in interface GlossaryAuthorViewRelationships

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<Relationship>

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