Package org.odpi.openmetadata.accessservices.communityprofile.server

Class ValidValuesRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.communityprofile.server.ValidValuesRESTServices
public class ValidValuesRESTServices extends Object
ValidValuesRESTServices provides the API operations to create and maintain validValues information.

  • Constructor Details

    • ValidValuesRESTServices

      public ValidValuesRESTServices()
      Default constructor

  • Method Details

    • createValidValue

      public GUIDResponse createValidValue(String serverName, String userId, ReferenceableRequestBody requestBody)
      Create a new metadata element to represent a validValues.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - properties to store
      Returns:
      unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • updateValidValue

      public VoidResponse updateValidValue(String serverName, String userId, String validValueGUID, boolean isMergeUpdate, ReferenceableRequestBody requestBody)
      Update the metadata element representing a validValues.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      validValueGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with the existing properties of overlay them?
      requestBody - new properties for this element
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • setupValidValueMember

      public VoidResponse setupValidValueMember(String serverName, String userId, String validValueSetGUID, String validValueMemberGUID, RelationshipRequestBody requestBody)
      Create a membership relationship between a validValue and a validValueSet that it belongs to.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      validValueSetGUID - unique identifier of the valid value set
      validValueMemberGUID - unique identifier of the member
      requestBody - relationship properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • clearValidValueMember

      public VoidResponse clearValidValueMember(String serverName, String userId, String validValueSetGUID, String validValueMemberGUID, ExternalSourceRequestBody requestBody)
      Remove a membership relationship between a validValue and a validValueSet that it belongs to.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      validValueSetGUID - unique identifier of the valid value set
      validValueMemberGUID - unique identifier of the member
      requestBody - external source identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • setupValidValues

      public VoidResponse setupValidValues(String serverName, String userId, String elementGUID, String validValueGUID, RelationshipRequestBody requestBody)
      Create a valid value assignment relationship between an element and a valid value (typically, a valid value set) to show that the valid value defines the values that can be stored in the data item that the element represents.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element
      validValueGUID - unique identifier of the valid value
      requestBody - relationship properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • clearValidValues

      public VoidResponse clearValidValues(String serverName, String userId, String elementGUID, String validValueGUID, ExternalSourceRequestBody requestBody)
      Remove a valid value assignment relationship between an element and a valid value.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element
      validValueGUID - unique identifier of the valid value
      requestBody - external source identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • setupReferenceValueTag

      public VoidResponse setupReferenceValueTag(String serverName, String userId, String elementGUID, String validValueGUID, RelationshipRequestBody requestBody)
      Create a reference value assignment relationship between an element and a valid value to show that the valid value is a semiformal tag/classification.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element
      validValueGUID - unique identifier of the valid value
      requestBody - relationship properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • clearReferenceValueTag

      public VoidResponse clearReferenceValueTag(String serverName, String userId, String elementGUID, String validValueGUID, ExternalSourceRequestBody requestBody)
      Remove a reference value assignment relationship between an element and a valid value.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element
      validValueGUID - unique identifier of the valid value
      requestBody - external source identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • removeValidValue

      public VoidResponse removeValidValue(String serverName, String userId, String validValueGUID, ExternalSourceRequestBody requestBody)
      Remove the metadata element representing a validValue.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      validValueGUID - unique identifier of the metadata element to remove
      requestBody - external source identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • findValidValues

      public ValidValuesResponse findValidValues(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of validValue metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getValidValuesByName

      public ValidValuesResponse getValidValuesByName(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of validValue metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getValidValueSetMembers

      public ValidValuesResponse getValidValueSetMembers(String serverName, String userId, String validValueSetGUID, int startFrom, int pageSize)
      Page through the members of a valid value set.
      Parameters:
      serverName - called server
      userId - calling user
      validValueSetGUID - unique identifier of the valid value set
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of valid value beans InvalidParameterException name or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getSetsForValidValue

      public ValidValuesResponse getSetsForValidValue(String serverName, String userId, String validValueGUID, int startFrom, int pageSize)
      Page through the list of valid value sets that a valid value definition/set belongs to.
      Parameters:
      serverName - called server
      userId - calling user
      validValueGUID - unique identifier of the valid value
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of valid value beans InvalidParameterException name or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getValidValuesForConsumer

      public ValidValueResponse getValidValuesForConsumer(String serverName, String userId, String elementGUID)
      Return information about the valid value set linked to an element as its set of valid values.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier for the element using the valid value set
      Returns:
      matching metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getConsumersOfValidValue

      public RelatedElementsResponse getConsumersOfValidValue(String serverName, String userId, String validValueGUID, int startFrom, int pageSize)
      Return information about the consumers linked to a valid value.
      Parameters:
      serverName - called server
      userId - calling user
      validValueGUID - unique identifier for the validValue
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of matching person roles InvalidParameterException name or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getReferenceValues

      public ValidValuesResponse getReferenceValues(String serverName, String userId, String elementGUID, int startFrom, int pageSize)
      Return information about the valid values linked as reference value tags to an element.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier for the element using the valid value set
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getAssigneesOfReferenceValue

      public RelatedElementsResponse getAssigneesOfReferenceValue(String serverName, String userId, String validValueGUID, int startFrom, int pageSize)
      Return information about the consumers linked to a valid value.
      Parameters:
      serverName - called server
      userId - calling user
      validValueGUID - unique identifier for the validValue
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of matching person roles InvalidParameterException name or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getAllValidValues

      public ValidValuesResponse getAllValidValues(String serverName, String userId, int startFrom, int pageSize)
      Retrieve the list of validValue metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getValidValueByGUID

      public ValidValueResponse getValidValueByGUID(String serverName, String userId, String guid)
      Retrieve the validValue metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      matching metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)