Package org.odpi.openmetadata.accessservices.datamanager.client

Class ValidValueManagement

java.lang.Object
org.odpi.openmetadata.accessservices.datamanager.client.DataManagerBaseClient
org.odpi.openmetadata.accessservices.datamanager.client.ValidValueManagement
All Implemented Interfaces:
org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
public class ValidValueManagement extends DataManagerBaseClient implements org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
ValidValueManagerClient supports the APIs to maintain valid values and their related objects.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ValidValueManagement(String serverName, String serverPlatformURLRoot)
    Create a new client with no authentication embedded in the HTTP request.
    ValidValueManagement(String serverName, String serverPlatformURLRoot, String userId, String password)
    Create a new client that passes userId and password in each HTTP request.
    ValidValueManagement(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client that passes userId and password in each HTTP request.
    ValidValueManagement(String serverName, String serverPlatformURLRoot, DataManagerRESTClient restClient, int maxPageSize)
    Create a new client that is going to be used in an OMAG Server.
    ValidValueManagement(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client with no authentication embedded in the HTTP request.

  • 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 a valid value.
    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.RelatedElement>
    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.RelatedElement>
    getConsumersOfValidValue(String userId, String validValueGUID, int startFrom, int pageSize)
    Return information about the consumers linked to a validValue.
    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 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 valid value.
    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 valid value.

    Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.client.DataManagerBaseClient

    removeReferenceable

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ValidValueManagement

      public ValidValueManagement(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • ValidValueManagement

      public ValidValueManagement(String serverName, String serverPlatformURLRoot) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • ValidValueManagement

      public ValidValueManagement(String serverName, String serverPlatformURLRoot, String userId, String password) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • ValidValueManagement

      public ValidValueManagement(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • ValidValueManagement

      public ValidValueManagement(String serverName, String serverPlatformURLRoot, DataManagerRESTClient restClient, int maxPageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that is going to be used in an OMAG Server.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      restClient - client that issues the REST API calls
      maxPageSize - maximum number of results supported by this server
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

  • Method Details

    • createValidValue

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

    • updateValidValue

      public 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.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the metadata element representing a valid value. It is possible to use the subtype property classes or set up specialized properties in extended properties.
      Specified by:
      updateValidValue in interface org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
      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 the metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupValidValueMember

      public 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.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a membership relationship between a validValue and a validValueSet that it belongs to.
      Specified by:
      setupValidValueMember in interface org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
      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.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearValidValueMember

      public void clearValidValueMember(String userId, String externalSourceGUID, String externalSourceName, String validValueSetGUID, String validValueMemberGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove a membership relationship between a validValue and a validValueSet that it belongs to.
      Specified by:
      clearValidValueMember in interface org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
      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 member
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupValidValues

      public 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.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.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.
      Specified by:
      setupValidValues in interface org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
      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.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearValidValues

      public void clearValidValues(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String validValueGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove a valid value assignment relationship between an element and a valid value.
      Specified by:
      clearValidValues in interface org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
      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.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupReferenceValueTag

      public 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.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.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.
      Specified by:
      setupReferenceValueTag in interface org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
      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.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearReferenceValueTag

      public void clearReferenceValueTag(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String validValueGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove a reference value assignment relationship between an element and a valid value.
      Specified by:
      clearReferenceValueTag in interface org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
      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.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeValidValue

      public void removeValidValue(String userId, String externalSourceGUID, String externalSourceName, String validValueGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the metadata element representing a valid value.
      Specified by:
      removeValidValue in interface org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
      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.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findValidValues

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement> findValidValues(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findValidValues in interface org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
      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.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getValidValuesByName

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement> getValidValuesByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getValidValuesByName in interface org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
      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.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getAllValidValues

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement> getAllValidValues(String userId, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of valid values.
      Specified by:
      getAllValidValues in interface org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
      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.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getValidValueSetMembers

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement> getValidValueSetMembers(String userId, String validValueSetGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Page through the members of a valid value set.
      Specified by:
      getValidValueSetMembers in interface org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
      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.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.

    • getSetsForValidValue

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement> getSetsForValidValue(String userId, String validValueGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Page through the list of valid value sets that a valid value definition/set belongs to.
      Specified by:
      getSetsForValidValue in interface org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
      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.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.

    • getValidValuesForConsumer

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

    • getConsumersOfValidValue

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getConsumersOfValidValue(String userId, String validValueGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return information about the consumers linked to a validValue.
      Specified by:
      getConsumersOfValidValue in interface org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
      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.connectors.ffdc.InvalidParameterException - name or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • getReferenceValues

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement> getReferenceValues(String userId, String elementGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return information about the valid values linked as reference value tags to an element.
      Specified by:
      getReferenceValues in interface org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
      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.connectors.ffdc.InvalidParameterException - name or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • getAssigneesOfReferenceValue

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getAssigneesOfReferenceValue(String userId, String validValueGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return information about the person roles linked to a validValue.
      Specified by:
      getAssigneesOfReferenceValue in interface org.odpi.openmetadata.accessservices.datamanager.api.ValidValueManagementInterface
      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.connectors.ffdc.InvalidParameterException - name or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • getValidValueByGUID

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