Class GlossaryAuthorViewRestClient

    • Constructor Summary

      Constructors 
      Constructor Description
      GlossaryAuthorViewRestClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.odpi.openmetadata.accessservices.subjectarea.utils.QueryBuilder createFindQuery​(java.lang.String methodName, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)
      Method for constructing a query (https://en.wikipedia.org/wiki/Query_string) using the information described in the findRequest page size and startingFrom need to set by the caller.
      org.odpi.openmetadata.accessservices.subjectarea.utils.QueryBuilder createFindQuery​(java.lang.String methodName, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase)  
      org.odpi.openmetadata.accessservices.subjectarea.utils.QueryBuilder createFindQuery​(java.lang.String methodName, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, org.odpi.openmetadata.accessservices.subjectarea.utils.QueryParams queryParams)
      Method for constructing a query (https://en.wikipedia.org/wiki/Query_string) using the information described in the findRequest page size and startingFrom need to set by the caller.
      <T> GenericResponse<T> delRESTCall​(java.lang.String userId, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> parameterizedType, java.lang.String methodName, java.lang.String urnTemplate, java.lang.String guid)
      Issue a DEL REST call that returns a response object.
      <T> GenericResponse<T> findRESTCall​(java.lang.String userId, java.lang.String methodName, java.lang.String urnTemplate, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase, java.lang.Integer maximumPageSizeOnRestCall)
      Issue a GET REST call that does a find and returns results in a Generic Response.
      <T> GenericResponse<T> findRESTCallById​(java.lang.String userId, java.lang.String methodName, java.lang.String urnTemplate, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase, java.lang.Integer maximumPageSizeOnRestCall, java.lang.String guid)
      Issue a GET REST call that does a find and returns results in a Generic Response.
      <T> GenericResponse<T> getByGUIdRESTCall​(java.lang.String userId, java.lang.String guid, java.lang.String methodName, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, java.lang.String urnTemplate)
      Issue a GET REST call that returns a response object by guid.
      <T> GenericResponse<T> getByIdRESTCall​(java.lang.String userId, java.lang.String guid, java.lang.String methodName, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, java.lang.String urnTemplate)
      Issue a GET REST call that returns a response object by guid.
      <T> GenericResponse<T> getByIdRESTCall​(java.lang.String userId, java.lang.String guid, java.lang.String methodName, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, java.lang.String urnTemplate, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, java.lang.Integer maximumPageSizeOnRestCall, java.util.Map<java.lang.String,​java.lang.String> params)
      Issue a GET REST call that returns a response object by guid.
      <T> GenericResponse<T> getByIdRESTCall​(java.lang.String userId, java.lang.String guid, java.lang.String methodName, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, java.lang.String urnTemplate, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, java.lang.Integer maximumPageSizeOnRestCall, org.odpi.openmetadata.accessservices.subjectarea.utils.QueryParams queryParams)
      Issue a GET REST call that returns a response object by guid.
      OMAGServerConfigResponse getConfigRESTCall​(java.lang.String userId, java.lang.String guid, java.lang.String methodName, java.lang.Class<OMAGServerConfigResponse> type, java.lang.String urnTemplate)
      Issue a GET REST call that returns a Config object by guid.
      ViewServicesResponse getViewConfigRESTCall​(java.lang.String userId, java.lang.String methodName, java.lang.Class<ViewServicesResponse> type, java.lang.String urnTemplate)
      Issue a GET REST call that returns a View Config object by guid.
      ViewServiceConfigResponse getViewServiceConfigRESTCall​(java.lang.String userId, java.lang.String guid, java.lang.String methodName, java.lang.Class<ViewServiceConfigResponse> type, java.lang.String urnTemplate)
      Issue a GET REST call that returns a View Config object by guid.
      <T> GenericResponse<T> postRESTCall​(java.lang.String userId, java.lang.String methodName, java.lang.String urlTemplate, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type, java.lang.String guid)
      Issue a POST REST call that returns a response object.
      <T> GenericResponse<T> postRESTCall​(java.lang.String userId, java.lang.String create, java.lang.String urnTemplate, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> parameterizedType, T t)
      Issue a POST REST call that returns a response object.
      org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term>> postRESTCallArr​(java.lang.String userId, java.lang.String methodName, java.lang.String urlTemplate, java.lang.String guid, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term>>> type, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term[] termArray)
      Issue a POST REST call that returns a response array.
      <T> GenericResponse<T> putRESTCall​(java.lang.String userId, java.lang.String guid, java.lang.String methodName, java.lang.String urnTemplate, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> parameterizedType, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category category, java.lang.Object... params)
      Issue a PUT REST call that returns a response object.
      <T> GenericResponse<T> putRESTCall​(java.lang.String userId, java.lang.String guid, java.lang.String methodName, java.lang.String urnTemplate, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> parameterizedType, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary glossary, java.lang.Object... params)
      Issue a PUT REST call that returns a response object.
      <T> GenericResponse<T> putRESTCall​(java.lang.String userId, java.lang.String guid, java.lang.String methodName, java.lang.String urlTemplate, org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> parameterizedType, T t)
      Issue a PUT REST call that returns a response object.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getByGUIdRESTCall

        public <T> GenericResponse<T> getByGUIdRESTCall​(java.lang.String userId,
                                                        java.lang.String guid,
                                                        java.lang.String methodName,
                                                        org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type,
                                                        java.lang.String urnTemplate)
                                                 throws InvalidParameterException,
                                                        PropertyServerException,
                                                        UserNotAuthorizedException
        Issue a GET REST call that returns a response object by guid.
        Type Parameters:
        T - return type for results in GenericResponse
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed
        guid - unique identifier of the received object
        methodName - name of the method being called.
        type - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
        urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
        Returns:
        GenericResponse with T result
        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
      • postRESTCall

        public <T> GenericResponse<T> postRESTCall​(java.lang.String userId,
                                                   java.lang.String create,
                                                   java.lang.String urnTemplate,
                                                   org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> parameterizedType,
                                                   T t)
                                            throws PropertyServerException,
                                                   InvalidParameterException,
                                                   UserNotAuthorizedException
        Issue a POST REST call that returns a response object. The object to be created is passed.
        Type Parameters:
        T - return type for results in GenericResponse
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed
        create - name of the action/method been called.
        urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
        parameterizedType - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
        t - object to be creates
        Returns:
        GenericResponse with T result
        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
      • postRESTCallArr

        public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term>> postRESTCallArr​(java.lang.String userId,
                                                                                                                                                                                                                                                                                           java.lang.String methodName,
                                                                                                                                                                                                                                                                                           java.lang.String urlTemplate,
                                                                                                                                                                                                                                                                                           java.lang.String guid,
                                                                                                                                                                                                                                                                                           org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term>>> type,
                                                                                                                                                                                                                                                                                           org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term[] termArray)
                                                                                                                                                                                                                                                                                    throws PropertyServerException,
                                                                                                                                                                                                                                                                                           InvalidParameterException,
                                                                                                                                                                                                                                                                                           UserNotAuthorizedException
        Issue a POST REST call that returns a response array. The array of objects to be created is passed.
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed
        methodName - name of the method being called.
        urlTemplate - template of the URN for the REST API call with place-holders for the parameters.
        guid - unique identifier of the glossary object
        type - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
        termArray - Array of terms to be creates
        Returns:
        Array of type SubjectAreaOMASAPIResponse
        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
      • putRESTCall

        public <T> GenericResponse<T> putRESTCall​(java.lang.String userId,
                                                  java.lang.String guid,
                                                  java.lang.String methodName,
                                                  java.lang.String urnTemplate,
                                                  org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> parameterizedType,
                                                  org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary glossary,
                                                  java.lang.Object... params)
                                           throws PropertyServerException,
                                                  InvalidParameterException,
                                                  UserNotAuthorizedException
        Issue a PUT REST call that returns a response object. The object to be updated is passed.
        Type Parameters:
        T - return type for results in GenericResponse
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed
        guid - unique identifier of the object
        methodName - name of the method being called.
        urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
        parameterizedType - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
        glossary - Glossary to be creates
        params - additional parameters to be passed
        Returns:
        GenericResponse with T result
        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
      • putRESTCall

        public <T> GenericResponse<T> putRESTCall​(java.lang.String userId,
                                                  java.lang.String guid,
                                                  java.lang.String methodName,
                                                  java.lang.String urnTemplate,
                                                  org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> parameterizedType,
                                                  org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category category,
                                                  java.lang.Object... params)
                                           throws PropertyServerException,
                                                  InvalidParameterException,
                                                  UserNotAuthorizedException
        Issue a PUT REST call that returns a response object. The object to be updated is passed.
        Type Parameters:
        T - return type for results in GenericResponse
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed
        guid - unique identifier of the object
        methodName - name of the method being called.
        urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
        parameterizedType - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
        category - Category to be creates
        params - additional parameters to be passed
        Returns:
        GenericResponse with T result
        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
      • putRESTCall

        public <T> GenericResponse<T> putRESTCall​(java.lang.String userId,
                                                  java.lang.String guid,
                                                  java.lang.String methodName,
                                                  java.lang.String urlTemplate,
                                                  org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> parameterizedType,
                                                  T t)
                                           throws PropertyServerException,
                                                  InvalidParameterException,
                                                  UserNotAuthorizedException
        Issue a PUT REST call that returns a response object. The object to be updated is passed.
        Type Parameters:
        T - return type for results in GenericResponse
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed
        guid - unique identifier of the object
        methodName - name of the method being called.
        urlTemplate - template of the URN for the REST API call with place-holders for the parameters.
        parameterizedType - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
        t - type of object to be creates
        Returns:
        GenericResponse with T result
        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
      • delRESTCall

        public <T> GenericResponse<T> delRESTCall​(java.lang.String userId,
                                                  org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> parameterizedType,
                                                  java.lang.String methodName,
                                                  java.lang.String urnTemplate,
                                                  java.lang.String guid)
                                           throws PropertyServerException
        Issue a DEL REST call that returns a response object.
        Type Parameters:
        T - return type for results in GenericResponse
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed
        parameterizedType - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
        methodName - name of the method being called.
        urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
        guid - unique identifier of the object
        Returns:
        GenericResponse with T result
        Throws:
        PropertyServerException - something went wrong with the REST call stack.
      • createFindQuery

        public org.odpi.openmetadata.accessservices.subjectarea.utils.QueryBuilder createFindQuery​(java.lang.String methodName,
                                                                                                   org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)
                                                                                            throws InvalidParameterException
        Method for constructing a query (https://en.wikipedia.org/wiki/Query_string) using the information described in the findRequest page size and startingFrom need to set by the caller.
        Parameters:
        methodName - name of the method being called.
        findRequest - FindRequest
        Returns:
        query
        Throws:
        InvalidParameterException - one of the parameters is null or invalid
      • createFindQuery

        public org.odpi.openmetadata.accessservices.subjectarea.utils.QueryBuilder createFindQuery​(java.lang.String methodName,
                                                                                                   org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest,
                                                                                                   boolean exactValue,
                                                                                                   boolean ignoreCase)
                                                                                            throws InvalidParameterException
        Throws:
        InvalidParameterException
      • createFindQuery

        public org.odpi.openmetadata.accessservices.subjectarea.utils.QueryBuilder createFindQuery​(java.lang.String methodName,
                                                                                                   org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest,
                                                                                                   org.odpi.openmetadata.accessservices.subjectarea.utils.QueryParams queryParams)
                                                                                            throws InvalidParameterException
        Method for constructing a query (https://en.wikipedia.org/wiki/Query_string) using the information described in the findRequest page size and startingFrom need to set by the caller.
        Parameters:
        methodName - name of the method being called.
        findRequest - FindRequest
        queryParams - query parameters
        Returns:
        query
        Throws:
        InvalidParameterException - one of the parameters is null or invalid
      • findRESTCall

        public <T> GenericResponse<T> findRESTCall​(java.lang.String userId,
                                                   java.lang.String methodName,
                                                   java.lang.String urnTemplate,
                                                   org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type,
                                                   org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest,
                                                   boolean exactValue,
                                                   boolean ignoreCase,
                                                   java.lang.Integer maximumPageSizeOnRestCall)
                                            throws InvalidParameterException,
                                                   PropertyServerException,
                                                   UserNotAuthorizedException
        Issue a GET REST call that does a find and returns results in a Generic Response.
        Type Parameters:
        T - return type for results in GenericResponse
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed
        methodName - name of the method being called.
        urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
        type - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
        findRequest - FindRequest
        exactValue - boolean to determine search parameters should return exact values
        ignoreCase - boolean to determine search parameters should ignore case for teh search criteris
        maximumPageSizeOnRestCall - Page size for results
        Returns:
        GenericResponse with T result
        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
      • findRESTCallById

        public <T> GenericResponse<T> findRESTCallById​(java.lang.String userId,
                                                       java.lang.String methodName,
                                                       java.lang.String urnTemplate,
                                                       org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type,
                                                       org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest,
                                                       boolean exactValue,
                                                       boolean ignoreCase,
                                                       java.lang.Integer maximumPageSizeOnRestCall,
                                                       java.lang.String guid)
                                                throws InvalidParameterException,
                                                       PropertyServerException,
                                                       UserNotAuthorizedException
        Issue a GET REST call that does a find and returns results in a Generic Response.
        Type Parameters:
        T - return type for results in GenericResponse
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed
        methodName - name of the method being called.
        urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
        type - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
        findRequest - FindRequest
        exactValue - boolean to determine search parameters should return exact values
        ignoreCase - boolean to determine search parameters should ignore case for teh search criteris
        maximumPageSizeOnRestCall - Page size for results
        guid - Object guid
        Returns:
        GenericResponse with T result
        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
      • getByIdRESTCall

        public <T> GenericResponse<T> getByIdRESTCall​(java.lang.String userId,
                                                      java.lang.String guid,
                                                      java.lang.String methodName,
                                                      org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type,
                                                      java.lang.String urnTemplate,
                                                      org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest,
                                                      java.lang.Integer maximumPageSizeOnRestCall,
                                                      java.util.Map<java.lang.String,​java.lang.String> params)
                                               throws InvalidParameterException,
                                                      PropertyServerException,
                                                      UserNotAuthorizedException
        Issue a GET REST call that returns a response object by guid.
        Type Parameters:
        T - return type for results in GenericResponse
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed
        guid - unique identifier of the object
        methodName - name of the method being called.
        type - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
        urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
        findRequest - FindRequest
        maximumPageSizeOnRestCall - maximum page size that can be used on rest calls, null and 0 mean no limit set.
        params - additional parameters to be passed
        Returns:
        GenericResponse with T result
        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
      • getByIdRESTCall

        public <T> GenericResponse<T> getByIdRESTCall​(java.lang.String userId,
                                                      java.lang.String guid,
                                                      java.lang.String methodName,
                                                      org.springframework.core.ParameterizedTypeReference<GenericResponse<T>> type,
                                                      java.lang.String urnTemplate,
                                                      org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest,
                                                      java.lang.Integer maximumPageSizeOnRestCall,
                                                      org.odpi.openmetadata.accessservices.subjectarea.utils.QueryParams queryParams)
                                               throws InvalidParameterException,
                                                      PropertyServerException,
                                                      UserNotAuthorizedException
        Issue a GET REST call that returns a response object by guid.
        Type Parameters:
        T - return type for results in GenericResponse
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed
        guid - unique identifier of the object
        methodName - name of the method being called.
        type - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
        urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
        findRequest - FindRequest
        maximumPageSizeOnRestCall - maximum page size that can be used on rest calls, null and 0 mean no limit set.
        queryParams - additional parameters to be passed
        Returns:
        GenericResponse with T result
        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
      • getConfigRESTCall

        public OMAGServerConfigResponse getConfigRESTCall​(java.lang.String userId,
                                                          java.lang.String guid,
                                                          java.lang.String methodName,
                                                          java.lang.Class<OMAGServerConfigResponse> type,
                                                          java.lang.String urnTemplate)
                                                   throws InvalidParameterException,
                                                          PropertyServerException,
                                                          UserNotAuthorizedException
        Issue a GET REST call that returns a Config object by guid.
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed
        guid - unique identifier of the object
        methodName - name of the method being called.
        type - class of the response for generic object.
        urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
        Returns:
        OMAGServerConfigResponse with T result
        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
      • getViewServiceConfigRESTCall

        public ViewServiceConfigResponse getViewServiceConfigRESTCall​(java.lang.String userId,
                                                                      java.lang.String guid,
                                                                      java.lang.String methodName,
                                                                      java.lang.Class<ViewServiceConfigResponse> type,
                                                                      java.lang.String urnTemplate)
                                                               throws InvalidParameterException,
                                                                      PropertyServerException,
                                                                      UserNotAuthorizedException
        Issue a GET REST call that returns a View Config object by guid.
        Parameters:
        userId - unique identifier for requesting user, under which the request is performed
        guid - unique identifier of the object
        methodName - name of the method being called.
        type - class of the response for generic object.
        urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
        Returns:
        ViewServiceConfigResponse object
        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