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

Class GlossaryAuthorViewTermClient

java.lang.Object

org.odpi.openmetadata.viewservices.glossaryauthor.fvt.client.term.GlossaryAuthorViewTermClient

All Implemented Interfaces:

ResponseParameterization<Term>, GlossaryAuthorViewTerm

public class GlossaryAuthorViewTermClient
extends Object
implements GlossaryAuthorViewTerm, ResponseParameterization<Term>

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final GlossaryAuthorViewRestClient	client

Constructor Summary

Constructors

Constructor	Description
GlossaryAuthorViewTermClient(GlossaryAuthorViewRestClient client)

Method Summary

Modifier and Type	Method	Description
Term	create(String userId, Term term)	Create a Term.
void	delete(String userId, String guid)	Delete a Term.
List<Term>	find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Extract children within a Term
List<Term>	findAll(String userId)	Find Terms
List<Relationship>	getAllRelationships(String userId, String guid)	Get a Term's relationships
Term	getByGUID(String userId, String guid)	Get a Term.
List<Category>	getCategories(String userId, String termGuid, FindRequest findRequest)	Extract Categories for a term
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)
List<Relationship>	getRelationships(String userId, String guid, FindRequest findRequest)	Extract Relationships for a term
List<ViewServiceConfig>	getViewServiceConfigs(String userId)	Get list of view service config on the server
Class<? extends GenericResponse>	responseType()
Term	restore(String userId, String guid)	Restore a soft-deleted Term.
Term	update(String userId, String guid, Term term)	Update a Term.
Term	update(String userId, String guid, Term term, boolean isReplace)	Update a Term.

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

GlossaryAuthorViewTermClient

public GlossaryAuthorViewTermClient(GlossaryAuthorViewRestClient client)

Method Details

getMethodInfo

protected String getMethodInfo(String methodName)

create

public Term create(String userId,
 Term term)
            throws PropertyServerException,
InvalidParameterException,
UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewTerm

Create a Term.

The result is the Term object

Specified by:

create in interface GlossaryAuthorViewTerm

Parameters:

userId - userId under which the request is performed

term - Term object to be created

Returns:

The Term

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 Term update(String userId,
 String guid,
 Term term)
            throws PropertyServerException,
InvalidParameterException,
UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewTerm

Update a Term.

The result is the updated Glossary object

Specified by:

update in interface GlossaryAuthorViewTerm

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be updated

term - Glossary object with updated values

Returns:

The updated Term

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

Description copied from interface: GlossaryAuthorViewTerm

Update a Term.

The result is the updated Glossary object

Specified by:

update in interface GlossaryAuthorViewTerm

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be updated

term - Glossary object with updated values

isReplace - If the object is to be replaced

Returns:

The updated Term

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

Delete a Term.

The result Void object

Specified by:

delete in interface GlossaryAuthorViewTerm

Parameters:

userId - userId under which the request is performed

guid - guid of Term object to be retrieved

Throws:

PropertyServerException - something went wrong with the REST call stack.

restore

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

Description copied from interface: GlossaryAuthorViewTerm

Restore a soft-deleted Term.

The result is the restored Term object

Specified by:

restore in interface GlossaryAuthorViewTerm

Parameters:

userId - userId under which the request is performed

guid - guid of Term object to be restored

Returns:

The restored Term

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

Extract children within a Category

Specified by:

getCategoryChildren in interface GlossaryAuthorViewTerm

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

Description copied from interface: GlossaryAuthorViewTerm

Find Terms

Specified by:

findAll in interface GlossaryAuthorViewTerm

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

Description copied from interface: GlossaryAuthorViewTerm

Get a Term.

The result is the requested Term object

Specified by:

getByGUID in interface GlossaryAuthorViewTerm

Parameters:

userId - userId under which the request is performed

guid - guid of Term object to be retrieved

Returns:

The requested Term

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

Description copied from interface: GlossaryAuthorViewTerm

Extract children within a Term

Specified by:

find in interface GlossaryAuthorViewTerm

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

Extract Categories for a term

Specified by:

getCategories in interface GlossaryAuthorViewTerm

Parameters:

userId - calling user

termGuid - GUID for the term

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

Returns:

list of Relationships

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

Get config for server

Specified by:

getConfig in interface GlossaryAuthorViewTerm

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

Get service config for a particular view Service

Specified by:

getGlossaryAuthViewServiceConfig in interface GlossaryAuthorViewTerm

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.

getRelationships

public List<Relationship> getRelationships(String userId,
 String guid,
 FindRequest findRequest)
                                    throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewTerm

Extract Relationships for a term

Specified by:

getRelationships in interface GlossaryAuthorViewTerm

Parameters:

userId - calling user

guid - GUID for the term

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

Returns:

list of Relationships

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

Get list of view service config on the server

Specified by:

getViewServiceConfigs in interface GlossaryAuthorViewTerm

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.

getAllRelationships

public List<Relationship> getAllRelationships(String userId,
 String guid)
                                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewTerm

Get a Term's relationships

The result is a list of Relationships

Specified by:

getAllRelationships in interface GlossaryAuthorViewTerm

Parameters:

userId - userId under which the request is performed

guid - guid of Term object to be retrieved

Returns:

The list of Term relationships

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

Returns:

the response class type inherited from GenericResponse