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

Class GlossaryAuthorViewGlossaryClient

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    GlossaryAuthorViewGlossaryClient(String serverName, String url)
     
    GlossaryAuthorViewGlossaryClient(GlossaryAuthorViewRestClient client)
     

  • Method Summary

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

    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

    • GlossaryAuthorViewGlossaryClient

      public GlossaryAuthorViewGlossaryClient(GlossaryAuthorViewRestClient client)

    • GlossaryAuthorViewGlossaryClient

      public GlossaryAuthorViewGlossaryClient(String serverName, String url) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

  • Method Details

    • find

      public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary> find(String userId, 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
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

    • find

      public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary> 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
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

    • find

      public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary> find(String userId, 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.glossary.Glossary>

    • create

      public org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary create(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary glossary) 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: GlossaryAuthorViewGlossary
      Create a Glossary.

      The result is the Glossary object

      Specified by:
      create in interface GlossaryAuthorViewGlossary
      Parameters:
      userId - userId under which the request is performed
      glossary - Glossary object to be created
      Returns:
      The Glossary
      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.

    • update

      public org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary update(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary glossary, 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: GlossaryAuthorViewGlossary
      Update a Glossary.

      The result is the updated Glossary object

      Specified by:
      update in interface GlossaryAuthorViewGlossary
      Parameters:
      userId - userId under which the request is performed
      guid - guid of Glossary object to be updated
      glossary - Glossary object with updated values
      isReplace - To replace existing Glossary or not
      Returns:
      The updated Glossary
      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.

    • getByGUID

      public org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary 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: GlossaryAuthorViewGlossary
      Get a Glossary.

      The result is the requested Glossary object

      Specified by:
      getByGUID in interface GlossaryAuthorViewGlossary
      Parameters:
      userId - userId under which the request is performed
      guid - guid of Glossary object to be retrieved
      Returns:
      The requested Glossary
      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.

    • delete

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

      The result Void object

      Specified by:
      delete in interface GlossaryAuthorViewGlossary
      Parameters:
      userId - userId under which the request is performed
      guid - guid of Glossary 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.glossary.Glossary 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: GlossaryAuthorViewGlossary
      Restore a soft-deleted Glossary.

      The result is the restored Glossary object

      Specified by:
      restore in interface GlossaryAuthorViewGlossary
      Parameters:
      userId - userId under which the request is performed
      guid - guid of Glossary object to be restored
      Returns:
      The restored Glossary
      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.

    • 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: GlossaryAuthorViewGlossary
      Get a Glossary's relationships

      The result is a list of Relationships

      Specified by:
      getAllRelationships in interface GlossaryAuthorViewGlossary
      Parameters:
      userId - userId under which the request is performed
      guid - guid of Glossary object to be retrieved
      Returns:
      The list of Glossary 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.

    • 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
      Description copied from interface: GlossaryAuthorViewGlossary
      Get the Categories owned by this glossary.
      Specified by:
      getCategories in interface GlossaryAuthorViewGlossary
      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.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.

    • 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) 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: GlossaryAuthorViewGlossary
      Get the Categories owned by this glossary.
      Specified by:
      getCategories in interface GlossaryAuthorViewGlossary
      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 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.

    • 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: GlossaryAuthorViewGlossary
      Extract terms within a glossary
      Specified by:
      getTerms in interface GlossaryAuthorViewGlossary
      Parameters:
      userId - calling user
      guid - glossary 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.

    • createTerms

      public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term> createTerms(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term[] termArray) 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: GlossaryAuthorViewGlossary
      Create multiple terms within a glossary
      Specified by:
      createTerms in interface GlossaryAuthorViewGlossary
      Parameters:
      userId - calling user
      guid - glossary GUID
      termArray - array of glossary objects that are to be created.
      Returns:
      list of terms created
      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.

    • 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