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

Class GlossaryAuthorViewCategoryClient

java.lang.Object
org.odpi.openmetadata.viewservices.glossaryauthor.fvt.client.category.GlossaryAuthorViewCategoryClient
All Implemented Interfaces:
org.odpi.openmetadata.commonservices.ffdc.rest.ResponseParameterization<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>, GlossaryAuthorViewCategory
public class GlossaryAuthorViewCategoryClient extends Object implements GlossaryAuthorViewCategory, org.odpi.openmetadata.commonservices.ffdc.rest.ResponseParameterization<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>
The class acts as a wrapper class for calling the REST services for Glossary Author Category related services.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GlossaryAuthorViewCategoryClient(GlossaryAuthorViewRestClient client)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category
    create(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category category)
    Create a Category.
    void
    delete(String userId, String guid)
    Delete a Category.
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>
    find(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase)
    Extract children within a Category
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>
    findAll(String userId)
    Find Category
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship>
    getAllRelationships(String userId, String guid)
    Get a Category's relationships
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category
    getByGUID(String userId, String guid)
    Get a Category.
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>
    getCategoryChildren(String userId, String parentGuid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase)
    Extract children within a Category
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship>
    getRelationships(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)
    Get a Category's relationships
    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)
    Extract terms within a 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, Integer maximumPageSizeOnRestCall)
     
    Class<? extends org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse>
    responseType()
     
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category
    restore(String userId, String guid)
    Restore a soft-deleted Category.
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category
    update(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category category, boolean isReplace)
    Update a Category.

    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

  • Constructor Details

  • Method Details

    • create

      public org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category create(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category category) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Description copied from interface: GlossaryAuthorViewCategory
      Create a Category.

      The result is the Category object

      Specified by:
      create in interface GlossaryAuthorViewCategory
      Parameters:
      userId - userId under which the request is performed
      category - Glossary object to be created
      Returns:
      The Category
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • update

      public org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category update(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category category, boolean isReplace) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Description copied from interface: GlossaryAuthorViewCategory
      Update a Category.

      The result is the updated Glossary object

      Specified by:
      update in interface GlossaryAuthorViewCategory
      Parameters:
      userId - userId under which the request is performed
      guid - guid of Glossary object to be updated
      category - Glossary object with updated values
      isReplace - If the object is to be replaced
      Returns:
      The updated Category
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • delete

      public void delete(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Description copied from interface: GlossaryAuthorViewCategory
      Delete a Category.

      The result Void object

      Specified by:
      delete in interface GlossaryAuthorViewCategory
      Parameters:
      userId - userId under which the request is performed
      guid - guid of Category object to be retrieved
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

    • restore

      public org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category restore(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Description copied from interface: GlossaryAuthorViewCategory
      Restore a soft-deleted Category.

      The result is the restored Category object

      Specified by:
      restore in interface GlossaryAuthorViewCategory
      Parameters:
      userId - userId under which the request is performed
      guid - guid of Category object to be restored
      Returns:
      The restored Category
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getCategoryChildren

      public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category> getCategoryChildren(String userId, String parentGuid, 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
      Description copied from interface: GlossaryAuthorViewCategory
      Extract children within a Category
      Specified by:
      getCategoryChildren in interface GlossaryAuthorViewCategory
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      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.

    • findAll

      public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category> findAll(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Description copied from interface: GlossaryAuthorViewCategory
      Find Category
      Specified by:
      findAll in interface GlossaryAuthorViewCategory
      Parameters:
      userId - calling user
      Returns:
      Categories belonging to Userid
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      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.

    • getByGUID

      public org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category getByGUID(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Description copied from interface: GlossaryAuthorViewCategory
      Get a Category.

      The result is the requested Category object

      Specified by:
      getByGUID in interface GlossaryAuthorViewCategory
      Parameters:
      userId - userId under which the request is performed
      guid - guid of Category object to be retrieved
      Returns:
      The requested Category
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      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.

    • find

      public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category> find(String userId, 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
      Description copied from interface: GlossaryAuthorViewCategory
      Extract children within a Category
      Specified by:
      find in interface GlossaryAuthorViewCategory
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      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.

    • getRelationships

      public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship> getRelationships(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
      Description copied from interface: GlossaryAuthorViewCategory
      Get a Category's relationships

      The result is a list of Relationships

      Specified by:
      getRelationships in interface GlossaryAuthorViewCategory
      Parameters:
      userId - userId under which the request is performed
      guid - guid of Category object to be retrieved
      findRequest - information object for find calls. This include pageSize to limit the number of elements returned.
      Returns:
      The list of Category relationships
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      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.

    • getAllRelationships

      public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship> getAllRelationships(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Description copied from interface: GlossaryAuthorViewCategory
      Get a Category's relationships

      The result is a list of Relationships

      Specified by:
      getAllRelationships in interface GlossaryAuthorViewCategory
      Parameters:
      userId - userId under which the request is performed
      guid - guid of Category object to be retrieved
      Returns:
      The list of Category relationships
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      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.

    • 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
      Description copied from interface: GlossaryAuthorViewCategory
      Extract terms within a Category
      Specified by:
      getTerms in interface GlossaryAuthorViewCategory
      Parameters:
      userId - calling user
      guid - Category GUID
      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.InvalidParameterException - one of the parameters is null or invalid
      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.

    • 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
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

    • responseType

      public Class<? extends org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse> responseType()
      Specified by:
      responseType in interface org.odpi.openmetadata.commonservices.ffdc.rest.ResponseParameterization<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>