Package org.odpi.openmetadata.accessservices.communityprofile.api

Interface ValidValueManagementInterface

public interface ValidValueManagementInterface
The ValidValueManagementInterface provides methods for managing valid values.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clearReferenceValueTag(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String validValueGUID)
    Remove a reference value assignment relationship between an element and a valid value.
    void
    clearValidValueMember(String userId, String externalSourceGUID, String externalSourceName, String validValueSetGUID, String validValueMemberGUID)
    Remove a membership relationship between a validValue and a validValueSet that it belongs to.
    void
    clearValidValues(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String validValueGUID)
    Remove a valid value assignment relationship between an element and a valid value.
    String
    createValidValue(String userId, String externalSourceGUID, String externalSourceName, org.odpi.openmetadata.frameworks.openmetadata.properties.validvalues.ValidValueProperties validValueProperties)
    Create a new metadata element to represent the validValue.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement>
    findValidValues(String userId, String searchString, int startFrom, int pageSize)
    Retrieve the list of metadata elements that contain the search string.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement>
    getAllValidValues(String userId, int startFrom, int pageSize)
    Retrieve the list of valid values.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElementStub>
    getAssigneesOfReferenceValue(String userId, String validValueGUID, int startFrom, int pageSize)
    Return information about the person roles linked to a validValue.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElementStub>
    getConsumersOfValidValue(String userId, String validValueGUID, int startFrom, int pageSize)
    Return information about the consumers linked to a valid value.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement>
    getReferenceValues(String userId, String elementGUID, int startFrom, int pageSize)
    Return information about the valid values linked as reference value tags to an element..
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement>
    getSetsForValidValue(String userId, String validValueGUID, int startFrom, int pageSize)
    Page through the list of valid value sets that a valid value definition/set belongs to.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement
    getValidValueByGUID(String userId, String validValueGUID)
    Retrieve the validValue metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement>
    getValidValuesByName(String userId, String name, int startFrom, int pageSize)
    Retrieve the list of metadata elements with a matching qualified or display name.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement>
    getValidValueSetMembers(String userId, String validValueSetGUID, int startFrom, int pageSize)
    Page through the members of a valid value set.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement
    getValidValuesForConsumer(String userId, String elementGUID)
    Return information about the valid value set linked to an element as its set of valid values.
    void
    removeValidValue(String userId, String externalSourceGUID, String externalSourceName, String validValueGUID)
    Remove the metadata element representing a validValue.
    void
    setupReferenceValueTag(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.validvalues.ReferenceValueAssignmentProperties properties, String validValueGUID)
    Create a reference value assignment relationship between an element and a valid value to show that the valid value is a semiformal tag/classification.
    void
    setupValidValueMember(String userId, String externalSourceGUID, String externalSourceName, String validValueSetGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.validvalues.ValidValueMembershipProperties properties, String validValueMemberGUID)
    Create a membership relationship between a validValue and a validValueSet that it belongs to.
    void
    setupValidValues(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.validvalues.ValidValueAssignmentProperties properties, String validValueGUID)
    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.
    void
    updateValidValue(String userId, String externalSourceGUID, String externalSourceName, String validValueGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.validvalues.ValidValueProperties validValueProperties)
    Update the metadata element representing a validValue.

  • Method Details

    • createValidValue

      String createValidValue(String userId, String externalSourceGUID, String externalSourceName, org.odpi.openmetadata.frameworks.openmetadata.properties.validvalues.ValidValueProperties validValueProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create a new metadata element to represent the validValue.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      validValueProperties - properties to store
      Returns:
      unique identifier of the new metadata element
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateValidValue

      void updateValidValue(String userId, String externalSourceGUID, String externalSourceName, String validValueGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.validvalues.ValidValueProperties validValueProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update the metadata element representing a validValue.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      validValueGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      validValueProperties - new properties for this element
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupValidValueMember

      void setupValidValueMember(String userId, String externalSourceGUID, String externalSourceName, String validValueSetGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.validvalues.ValidValueMembershipProperties properties, String validValueMemberGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create a membership relationship between a validValue and a validValueSet that it belongs to.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      validValueSetGUID - unique identifier of the valid value set
      properties - describes the properties of the membership
      validValueMemberGUID - unique identifier of the member
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearValidValueMember

      void clearValidValueMember(String userId, String externalSourceGUID, String externalSourceName, String validValueSetGUID, String validValueMemberGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Remove a membership relationship between a validValue and a validValueSet that it belongs to.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      validValueSetGUID - unique identifier of the valid value set
      validValueMemberGUID - unique identifier of the role
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupValidValues

      void setupValidValues(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.validvalues.ValidValueAssignmentProperties properties, String validValueGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      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:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      elementGUID - unique identifier of the element
      properties - describes the permissions that the role has in the validValue
      validValueGUID - unique identifier of the valid value
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearValidValues

      void clearValidValues(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String validValueGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Remove a valid value assignment relationship between an element and a valid value.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      elementGUID - unique identifier of the element
      validValueGUID - unique identifier of the valid value
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupReferenceValueTag

      void setupReferenceValueTag(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.validvalues.ReferenceValueAssignmentProperties properties, String validValueGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      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:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      elementGUID - unique identifier of the element
      properties - describes the quality of the assignment
      validValueGUID - unique identifier of the valid value
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearReferenceValueTag

      void clearReferenceValueTag(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String validValueGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Remove a reference value assignment relationship between an element and a valid value.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      elementGUID - unique identifier of the element
      validValueGUID - unique identifier of the valid value
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeValidValue

      void removeValidValue(String userId, String externalSourceGUID, String externalSourceName, String validValueGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Remove the metadata element representing a validValue. This will delete all anchored elements such as comments.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      validValueGUID - unique identifier of the metadata element to remove
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findValidValues

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement> findValidValues(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the list of metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      userId - calling user
      searchString - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getValidValuesByName

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement> getValidValuesByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the list of metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      userId - calling user
      name - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getAllValidValues

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement> getAllValidValues(String userId, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the list of valid values.
      Parameters:
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getValidValueSetMembers

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement> getValidValueSetMembers(String userId, String validValueSetGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Page through the members of a valid value set.
      Parameters:
      userId - calling user
      validValueSetGUID - unique identifier of the valid value set
      startFrom - paging starting point
      pageSize - maximum number of return values.
      Returns:
      list of valid value beans
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - the repository is not available or not working properly.

    • getSetsForValidValue

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement> getSetsForValidValue(String userId, String validValueGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Page through the list of valid value sets that a valid value definition/set belongs to.
      Parameters:
      userId - calling user
      validValueGUID - unique identifier of valid value to query
      startFrom - paging starting point
      pageSize - maximum number of return values.
      Returns:
      list of valid value beans
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - the repository is not available or not working properly.

    • getValidValuesForConsumer

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement getValidValuesForConsumer(String userId, String elementGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return information about the valid value set linked to an element as its set of valid values.
      Parameters:
      userId - calling user
      elementGUID - unique identifier for the element using the valid value
      Returns:
      list of matching actor profiles (hopefully only one)
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - name or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • getConsumersOfValidValue

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElementStub> getConsumersOfValidValue(String userId, String validValueGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return information about the consumers linked to a valid value.
      Parameters:
      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 actor profiles (hopefully only one)
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - name or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • getReferenceValues

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement> getReferenceValues(String userId, String elementGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return information about the valid values linked as reference value tags to an element..
      Parameters:
      userId - calling user
      elementGUID - unique identifier for the element
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of valid values
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - name or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • getAssigneesOfReferenceValue

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElementStub> getAssigneesOfReferenceValue(String userId, String validValueGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return information about the person roles linked to a validValue.
      Parameters:
      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 actor profiles (hopefully only one)
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - name or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • getValidValueByGUID

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement getValidValueByGUID(String userId, String validValueGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the validValue metadata element with the supplied unique identifier.
      Parameters:
      userId - calling user
      validValueGUID - unique identifier of the requested metadata element
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)