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

Class SubjectAreaCategoryClient<C extends org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>

java.lang.Object

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

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

org.odpi.openmetadata.accessservices.subjectarea.client.nodes.categories.SubjectAreaCategoryClient<C>

All Implemented Interfaces:

SubjectAreaClient<C>, SubjectAreaNodeClient<C>, org.odpi.openmetadata.commonservices.ffdc.rest.ResponseParameterization<C>

public class SubjectAreaCategoryClient<C extends org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>
extends AbstractSubjectAreaNode<C>

Field Summary

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

BASE_RELATIONSHIPS_URL, SUBJECT_AREA_BASE_URL

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

EMPTY_FIND_REQUEST

Constructor Summary

Constructors

Constructor	Description
SubjectAreaCategoryClient(SubjectAreaRestClient client)

Method Summary

Modifier and Type	Method	Description
List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>	getCategoryChildren(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)	Get the Category's children categories
List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>	getCategoryChildren(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Get the Category's children categories
List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term>	getTerms(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)	Get the terms owned by this Category
List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term>	getTerms(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Get the terms owned by this Category

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, responseType, restore, update

Methods inherited from class java.lang.Object

equals, 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, find, find, find, findAll, findAll, getByGUID, replace, restore, update, update

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

getAllRelationships

Constructor Details

SubjectAreaCategoryClient

public SubjectAreaCategoryClient(SubjectAreaRestClient client)

Method Details

getCategoryChildren

public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category> getCategoryChildren(String userId,
 String guid,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)
                                                                                                                throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Get the Category's children categories

Parameters:

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

guid - unique identifier of the Category

findRequest - specification of the search

Returns:

list of Category children

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.

getCategoryChildren

public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category> getCategoryChildren(String userId,
 String guid,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest,
 boolean exactValue,
 boolean ignoreCase)
                                                                                                                throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Get the Category's children categories

Parameters:

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

guid - unique identifier of the Category

findRequest - specification of the search

exactValue - should the result match exactly?

ignoreCase - should the match be case insensitive?

Returns:

list of Category children

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.

getTerms

public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term> getTerms(String userId,
 String guid,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)
                                                                                             throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Get the terms owned by this Category

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.

getTerms

public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term> getTerms(String userId,
 String guid,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest,
 boolean exactValue,
 boolean ignoreCase)
                                                                                             throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Get the terms owned by this Category

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.

exactValue - should the result match exactly?

ignoreCase - should the match be case insensitive?

Returns:

list of Terms

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.