Package org.odpi.openmetadata.accessservices.subjectarea.client.nodes.glossaries

Class SubjectAreaGlossaryClient<G extends Glossary>

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.client.AbstractSubjectArea<E>

org.odpi.openmetadata.accessservices.subjectarea.client.nodes.AbstractSubjectAreaNode<G>

org.odpi.openmetadata.accessservices.subjectarea.client.nodes.glossaries.SubjectAreaGlossaryClient<G>

All Implemented Interfaces:

SubjectAreaClient<G>, SubjectAreaNodeClient<G>, ResponseParameterization<G>

public class SubjectAreaGlossaryClient<G extends Glossary>
extends AbstractSubjectAreaNode<G>

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.subjectarea.client.AbstractSubjectArea

BASE_RELATIONSHIPS_URL, BASE_URL, client, SUBJECT_AREA_BASE_URL

Fields inherited from interface org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaClient

EMPTY_FIND_REQUEST

Constructor Summary

Constructors

Constructor	Description
SubjectAreaGlossaryClient(SubjectAreaRestClient client)

Method Summary

Modifier and Type	Method	Description
List<Category>	getCategories(String userId, String guid, FindRequest findRequest, Boolean onlyTop)	Get the Categories owned by this glossary.
List<Category>	getCategories(String userId, String guid, FindRequest findRequest, Boolean onlyTop, boolean exactValue, boolean ignoreCase)	Get the Categories owned by this glossary.
List<Category>	getCategories(String userId, String guid, FindRequest findRequest, Boolean onlyTop, boolean exactValue, boolean ignoreCase, Integer maximumPageSizeOnRestCall)	Get the Categories owned by this glossary.
List<Term>	getTerms(String userId, String guid, FindRequest findRequest)	Get the Terms owned by this glossary.
List<Term>	getTerms(String userId, String guid, FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Get the Terms owned by this glossary.
List<Term>	getTerms(String userId, String guid, FindRequest findRequest, boolean exactValue, boolean ignoreCase, Integer maximumPageSizeOnRestCall)	Get the Terms owned by this glossary.

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.client.nodes.AbstractSubjectAreaNode

getRelationships, getRelationships

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.client.AbstractSubjectArea

create, delete, find, find, find, getByGUID, getMethodInfo, responseType, restore, update

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

Methods inherited from interface org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaClient

create, delete, delete, find, find, find, findAll, findAll, getByGUID, purge, replace, restore, update, update

Methods inherited from interface org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaNodeClient

getAllRelationships

Constructor Detail

SubjectAreaGlossaryClient

public SubjectAreaGlossaryClient(SubjectAreaRestClient client)

Method Detail

getCategories

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

Get the Categories owned by this glossary.

Parameters:

userId - unique identifier for requesting user, under which the request is performed.

guid - unique identifier of the object to which the found objects should relate.

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

onlyTop - when only the top categories (those categories without parents) are 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.

getCategories

public List<Category> getCategories(String userId,
                                    String guid,
                                    FindRequest findRequest,
                                    Boolean onlyTop,
                                    boolean exactValue,
                                    boolean ignoreCase)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Get the Categories owned by this glossary.

Parameters:

userId - unique identifier for requesting user, under which the request is performed.

guid - unique identifier of the object to which the found objects should relate.

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

onlyTop - when only the top categories (those categories without parents) are 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.

getCategories

public List<Category> getCategories(String userId,
                                    String guid,
                                    FindRequest findRequest,
                                    Boolean onlyTop,
                                    boolean exactValue,
                                    boolean ignoreCase,
                                    Integer maximumPageSizeOnRestCall)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Get the Categories owned by this glossary.

Parameters:

userId - unique identifier for requesting user, under which the request is performed.

guid - unique identifier of the object to which the found objects should relate.

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

onlyTop - when only the top categories (those categories without parents) are returned.

maximumPageSizeOnRestCall - maximum page size that can be specified on a rest call

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.

getTerms

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

Get the Terms owned by this glossary.

Parameters:

userId - unique identifier for requesting user, under which the request is performed.

guid - unique identifier of the object to which the found objects should relate.

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

Returns:

list of Terms

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.

getTerms

public List<Term> getTerms(String userId,
                           String guid,
                           FindRequest findRequest,
                           boolean exactValue,
                           boolean ignoreCase)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Get the Terms owned by this glossary.

Parameters:

userId - unique identifier for requesting user, under which the request is performed.

guid - unique identifier of the object to which the found objects should relate.

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

Returns:

list of Terms

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.

getTerms

public List<Term> getTerms(String userId,
                           String guid,
                           FindRequest findRequest,
                           boolean exactValue,
                           boolean ignoreCase,
                           Integer maximumPageSizeOnRestCall)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Get the Terms owned by this glossary.

Parameters:

userId - unique identifier for requesting user, under which the request is performed.

guid - unique identifier of the object to which the found objects should relate.

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

maximumPageSizeOnRestCall - maximum page size on rest call.

Returns:

list of Terms

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.