Interface SubjectAreaClient<T>

  • Type Parameters:
    T - Glossary Artifact type for supplied and return. Interface describing common methods to client working with Subject area resources. This is the Subject Area client API, for use by the subject area expert. This API exposes SCRUD (search, create, read ,update, delete) operations that can be performed on a Glossary Artifact.
    All Known Subinterfaces:
    SubjectAreaNodeClient<E>, SubjectAreaRelationshipClient<L>
    All Known Implementing Classes:
    AbstractSubjectArea

    public interface SubjectAreaClient<T>
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest EMPTY_FIND_REQUEST  
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      T create​(java.lang.String userId, T supplied)
      Create a Glossary Artifact.
      void delete​(java.lang.String userId, java.lang.String guid)
      Delete a Glossary Artifact.
      java.util.List<T> find​(java.lang.String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)
      Request to find Glossary Artifacts of the type T.
      java.util.List<T> find​(java.lang.String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase)
      Request to find Glossary Artifacts of the type T.
      java.util.List<T> find​(java.lang.String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase, java.lang.Integer maximumPageSizeOnRestCall)
      Request to find Glossary Artifacts of the type T.
      default java.util.List<T> findAll​(java.lang.String userId)
      Request to find all Glossary Artifacts of the type T.
      default java.util.List<T> findAll​(java.lang.String userId, java.lang.Integer maximumPageSizeOnRestCall)
      Request to find all Glossary Artifacts of the type T.
      T getByGUID​(java.lang.String userId, java.lang.String guid)
      Get Glossary Artifact by guid
      default T replace​(java.lang.String userId, java.lang.String guid, T supplied)
      Replace a Glossary Artifact.
      T restore​(java.lang.String userId, java.lang.String guid)
      Restore of a soft deleted Glossary Artifact.
      default T update​(java.lang.String userId, java.lang.String guid, T supplied)
      Update a Glossary Artifact.
      T update​(java.lang.String userId, java.lang.String guid, T supplied, boolean isReplace)
      Update or replace a Glossary Artifact.
    • Field Detail

      • EMPTY_FIND_REQUEST

        static final org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest EMPTY_FIND_REQUEST
    • Method Detail

      • findAll

        default java.util.List<T> findAll​(java.lang.String userId,
                                          java.lang.Integer maximumPageSizeOnRestCall)
                                   throws InvalidParameterException,
                                          PropertyServerException,
                                          UserNotAuthorizedException
        Request to find all Glossary Artifacts of the type T. Be aware that getting all objects may incur a big performance hit when there are many objects.
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed.
        maximumPageSizeOnRestCall - maximum page size that can be used on rest calls, null and 0 mean no limit set.
        Returns:
        list all Glossary Artifacts of the T type.
        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.
      • find

        java.util.List<T> find​(java.lang.String userId,
                               org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException
        Request to find Glossary Artifacts of the type T.
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed.
        findRequest - information Glossary Artifact for find calls.
        Returns:
        list Glossary Artifacts of the T type relevant in the findRequest information.
        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.
      • find

        java.util.List<T> find​(java.lang.String userId,
                               org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest,
                               boolean exactValue,
                               boolean ignoreCase)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException
        Request to find Glossary Artifacts of the type T.
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed.
        findRequest - information Glossary Artifact for find calls.
        exactValue - should the result match exactly?
        ignoreCase - should the match be case insensitive?
        Returns:
        list Glossary Artifacts of the T type relevant in the findRequest information.
        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.
      • find

        java.util.List<T> find​(java.lang.String userId,
                               org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest,
                               boolean exactValue,
                               boolean ignoreCase,
                               java.lang.Integer maximumPageSizeOnRestCall)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException
        Request to find Glossary Artifacts of the type T. The downstream server is likely to have a maximum Page Size is will accept, the client can interrogate this value and include it on the maximumPageSizeOnRestCall parameter. This API will ensure will issue multiple rest calls if required to ensure requests only request the supported max page size.
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed.
        findRequest - information Glossary Artifact for find calls.
        exactValue - exactValue - when false values with trailing characters will match
        ignoreCase - ignore the case when matching
        maximumPageSizeOnRestCall - maximum page size that can be used on rest calls, null and 0 mean no limit set.
        Returns:
        list Glossary Artifacts of the T type relevant in the findRequest information.
        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.
      • update

        T update​(java.lang.String userId,
                 java.lang.String guid,
                 T supplied,
                 boolean isReplace)
          throws InvalidParameterException,
                 PropertyServerException,
                 UserNotAuthorizedException
        Update or replace a Glossary Artifact.
        Parameters:
        guid - unique identifier of the Glossary Artifact.
        userId - unique identifier for requesting user, under which the request is performed.
        supplied - Glossary Artifact to be updated or replaced.
        isReplace - flag to indicate that this update is a replace.
        Returns:
        updated Glossary Artifact.
        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.
      • replace

        default T replace​(java.lang.String userId,
                          java.lang.String guid,
                          T supplied)
                   throws InvalidParameterException,
                          PropertyServerException,
                          UserNotAuthorizedException
        Replace a Glossary Artifact. This means to override all the existing attributes with the supplied attributes.
        Parameters:
        guid - unique identifier of the Glossary Artifact.
        userId - unique identifier for requesting user, under which the request is performed.
        supplied - Glossary Artifact to be replaced.
        Returns:
        replaced Glossary Artifact.
        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.
      • update

        default T update​(java.lang.String userId,
                         java.lang.String guid,
                         T supplied)
                  throws InvalidParameterException,
                         PropertyServerException,
                         UserNotAuthorizedException
        Update a Glossary Artifact. This means to update the object with any non-null attributes from the supplied Glossary Artifact.
        Parameters:
        guid - unique identifier of the Glossary Artifact.
        userId - unique identifier for requesting user, under which the request is performed.
        supplied - Glossary Artifact to be updated.
        Returns:
        updated Glossary Artifact.
        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.