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

Class SubjectAreaGlossaryClient<G extends org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.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>, org.odpi.openmetadata.commonservices.ffdc.rest.ResponseParameterization<G>
public class SubjectAreaGlossaryClient<G extends org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary> extends AbstractSubjectAreaNode<G>

  • 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
    SubjectAreaGlossaryClient(SubjectAreaRestClient client)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>
    getCategories(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, Boolean onlyTop)
    Get the Categories owned by this glossary.
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>
    getCategories(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, Boolean onlyTop, boolean exactValue, boolean ignoreCase)
    Get the Categories owned by this glossary.
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>
    getCategories(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, Boolean onlyTop, boolean exactValue, boolean ignoreCase, Integer maximumPageSizeOnRestCall)
    Get the Categories owned by this glossary.
    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 glossary.
    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 glossary.
    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, 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, 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

  • Method Details

    • getCategories

      public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category> getCategories(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, Boolean onlyTop) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      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.

    • getCategories

      public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category> getCategories(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, Boolean onlyTop, 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 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.
      exactValue - should the match be an exact value?
      ignoreCase - should the search be case insensitive?
      Returns:
      list of Categories
      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.

    • getCategories

      public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category> getCategories(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, Boolean onlyTop, boolean exactValue, boolean ignoreCase, Integer maximumPageSizeOnRestCall) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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.
      exactValue - should the match be an exact value?
      ignoreCase - should the search be case insensitive?
      maximumPageSizeOnRestCall - maximum page size that can be specified on a rest call
      Returns:
      list of Categories
      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 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:
      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 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.
      exactValue - should the match be an exact value?
      ignoreCase - should the search 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.

    • 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, Integer maximumPageSizeOnRestCall) 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 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.
      exactValue - should the match be an exact value?
      ignoreCase - should the search be case insensitive?
      maximumPageSizeOnRestCall - maximum page size on rest call.
      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.