Package org.odpi.openmetadata.accessservices.digitalarchitecture.client

Class ReferenceDataManager

java.lang.Object
org.odpi.openmetadata.accessservices.digitalarchitecture.client.ReferenceDataManager
All Implemented Interfaces:
org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
public class ReferenceDataManager extends Object implements org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
ReferenceDataManager provides the API operations to create and maintain lists of valid value definitions grouped into a valid value set. Both valid value definitions and valid value sets have the same attributes and so inherit from ValidValue where all the attributes are defined. A set is just grouping of valid values. Valid value definitions and set can be nested many times in other valid value sets.

  • Constructor Details

    • ReferenceDataManager

      public ReferenceDataManager(String serverName, String serverPlatformURLRoot, int maxPageSize, 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 and an audit log.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      maxPageSize - maximum number of results supported by this server
      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.

    • ReferenceDataManager

      public ReferenceDataManager(String serverName, String serverPlatformURLRoot, int maxPageSize) 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
      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.

    • ReferenceDataManager

      public ReferenceDataManager(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize, 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. There is also an audit log destination.
      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
      maxPageSize - maximum number of results supported by this server
      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.

    • ReferenceDataManager

      public ReferenceDataManager(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize) 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
      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.

    • ReferenceDataManager

      public ReferenceDataManager(String serverName, String serverPlatformURLRoot, DigitalArchitectureRESTClient restClient, int maxPageSize, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that is going to be used in an OMAG Server (view service or integration service typically).
      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
      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.

  • Method Details

    • createValidValueSet

      public String createValidValueSet(String userId, String qualifiedName, String displayName, String description, String usage, String scope, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties) 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 valid value set. This just creates the Set itself. Members are added either as they are created, or they can be attached to a set after they are created.
      Specified by:
      createValidValueSet in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user.
      qualifiedName - unique name.
      displayName - displayable descriptive name.
      description - further information.
      usage - how/when should this set be used.
      scope - what is the scope of this set's values.
      additionalProperties - additional properties for this set.
      typeName - name of subtype of the definition (or null to use the standard open type)
      extendedProperties - properties that need to be populated into a subtype (or null for the standard open type).
      Returns:
      unique identifier for the new set
      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.

    • createValidValueDefinition

      public String createValidValueDefinition(String userId, String setGUID, boolean isDefaultValue, String qualifiedName, String displayName, String description, String usage, String scope, String preferredValue, String dataType, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties) 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 valid value definition.
      Specified by:
      createValidValueDefinition in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user.
      setGUID - unique identifier of the set to attach this to.
      isDefaultValue - is this the default value for the set?
      qualifiedName - unique name.
      displayName - displayable descriptive name.
      description - further information.
      usage - how/when should this value be used.
      preferredValue - the value that should be used in an implementation if possible.
      dataType - the data type of the preferred value.
      additionalProperties - additional properties for this definition.
      typeName - name of subtype of the definition (or null to use the standard open type)
      extendedProperties - properties that need to be populated into a subtype (or null for the standard open type).
      Returns:
      unique identifier for the new definition
      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.

    • updateValidValue

      public void updateValidValue(String userId, String validValueGUID, String qualifiedName, String displayName, String description, String usage, String scope, String preferredValue, String dataType, boolean isDeprecated, Map<String,String> additionalProperties, boolean isMergeUpdate, String typeName, Map<String,Object> extendedProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the properties of the valid value. All properties are updated. If only changing some if the properties, retrieve the current values from the repository and pass existing values back on this call if they are not to change.
      Specified by:
      updateValidValue in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user.
      validValueGUID - unique identifier of the valid value.
      qualifiedName - unique name.
      displayName - displayable descriptive name.
      description - further information.
      usage - how/when should this value be used.
      scope - what is the scope of the values.
      preferredValue - the value that should be used in an implementation if possible.
      dataType - the data type of the preferred value.
      isDeprecated - is this value deprecated?
      additionalProperties - additional properties for this valid value.
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      typeName - name of subtype of the definition (or null to use the standard open type)
      extendedProperties - properties that need to be populated into a subtype.
      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.

    • deleteValidValue

      public void deleteValidValue(String userId, String validValueGUID, String qualifiedName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the valid value form the repository. All links to it are deleted too.
      Specified by:
      deleteValidValue in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user
      validValueGUID - unique identifier of the value to delete
      qualifiedName - unique name of the value to delete. This is used to verify that the correct valid value is being deleted.
      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.

    • attachValidValueToSet

      public void attachValidValueToSet(String userId, String setGUID, String validValueGUID, boolean isDefaultValue) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a link between a valid value set or definition and a set. This means the valid value is a member of the set.
      Specified by:
      attachValidValueToSet in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user.
      setGUID - unique identifier of the set.
      validValueGUID - unique identifier of the valid value to add to the set.
      isDefaultValue - is this the default value for the set?
      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.

    • detachValidValueFromSet

      public void detachValidValueFromSet(String userId, String setGUID, 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 link between a valid value and a set it is a member of.
      Specified by:
      detachValidValueFromSet in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user
      setGUID - owning set
      validValueGUID - unique identifier of the member to be removed.
      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.

    • linkValidValueToImplementation

      public void linkValidValueToImplementation(String userId, String validValueGUID, String assetGUID, String symbolicName, String implementationValue, Map<String,String> additionalValues) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Link a valid value to an asset that provides the implementation. Typically, this method is used to link a valid value set to a code table.
      Specified by:
      linkValidValueToImplementation in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user.
      validValueGUID - unique identifier of the valid value.
      assetGUID - unique identifier of the asset that implements the valid value.
      symbolicName - lookup name for valid value
      implementationValue - value used in implementation
      additionalValues - additional values stored under the symbolic name
      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.

    • classifyAssetAsReferenceData

      public void classifyAssetAsReferenceData(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Add the ReferenceData classification to an asset. If the asset is already classified in this way, the method is a no-op.
      Specified by:
      classifyAssetAsReferenceData in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user.
      assetGUID - unique identifier of the asset that contains reference data.
      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.

    • unlinkValidValueFromImplementation

      public void unlinkValidValueFromImplementation(String userId, String validValueGUID, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the link between a valid value and an implementing asset.
      Specified by:
      unlinkValidValueFromImplementation in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user.
      validValueGUID - unique identifier of the valid value.
      assetGUID - unique identifier of the asset that used to implement 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 make this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the repository is not available or not working properly.

    • declassifyAssetAsReferenceData

      public void declassifyAssetAsReferenceData(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the ReferenceData classification form an Asset. If the asset was not classified in this way, this call is a no-op.
      Specified by:
      declassifyAssetAsReferenceData in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user.
      assetGUID - unique identifier of asset.
      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.

    • assignValidValueToConsumer

      public void assignValidValueToConsumer(String userId, String validValueGUID, String consumerGUID, boolean strictRequirement) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Link a valid value typically to a schema element or glossary term to show that it uses the valid values.
      Specified by:
      assignValidValueToConsumer in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user.
      validValueGUID - unique identifier of the valid value.
      consumerGUID - unique identifier of the element to link to.
      strictRequirement - the valid values defines the only values that are permitted.
      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.

    • unassignValidValueFromConsumer

      public void unassignValidValueFromConsumer(String userId, String validValueGUID, String consumerGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the link between a valid value and a consumer.
      Specified by:
      unassignValidValueFromConsumer in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user.
      validValueGUID - unique identifier of the valid value.
      consumerGUID - unique identifier of the element to remove the link from.
      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.

    • assignReferenceValueToItem

      public void assignReferenceValueToItem(String userId, String validValueGUID, String referenceableGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.validvalues.ReferenceValueAssignmentProperties properties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Link a valid value as a reference value to a referencable to act as a tag/classification to help with locating and grouping the referenceable.
      Specified by:
      assignReferenceValueToItem in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user.
      validValueGUID - unique identifier of the valid value.
      referenceableGUID - unique identifier of the element to link to.
      properties - properties for the relationship
      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.

    • unassignReferenceValueFromItem

      public void unassignReferenceValueFromItem(String userId, String validValueGUID, String referenceableGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the reference value link between a valid value and a referenceable (item).
      Specified by:
      unassignReferenceValueFromItem in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user.
      validValueGUID - unique identifier of the valid value.
      referenceableGUID - unique identifier of the element to remove the link from.
      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.

    • mapValidValues

      public void mapValidValues(String userId, String validValue1GUID, String validValue2GUID, String associationDescription, int confidence, String steward, String notes) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Link together 2 valid values from different sets that have equivalent values/meanings.
      Specified by:
      mapValidValues in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user.
      validValue1GUID - unique identifier of the valid value.
      validValue2GUID - unique identifier of the other valid value to link to.
      associationDescription - how are the valid values related?
      confidence - how confident is the steward that this mapping is correct (0-100).
      steward - identifier of steward
      notes - additional notes from the steward
      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.

    • unmapValidValues

      public void unmapValidValues(String userId, String validValue1GUID, String validValue2GUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the reference value link between a valid value and a referenceable (item).
      Specified by:
      unmapValidValues in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user.
      validValue1GUID - unique identifier of the valid value.
      validValue2GUID - unique identifier of the other valid value element to remove the link from.
      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.

    • 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 a specific valid value from the repository.
      Specified by:
      getValidValueByGUID in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user
      validValueGUID - unique identifier of the valid value.
      Returns:
      Valid value bean
      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.

    • getValidValueByName

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueElement> getValidValueByName(String userId, String validValueName, 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 a specific valid value from the repository. Duplicates may be returned if multiple valid values have been assigned the same qualified name.
      Specified by:
      getValidValueByName in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user
      validValueName - qualified name of the valid value.
      startFrom - paging starting point
      pageSize - maximum number of return values.
      Returns:
      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.

    • 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
      Locate valid values that match the search string. It considers the names, description, scope, usage and preferred value.
      Specified by:
      findValidValues in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user
      searchString - string value to look for - may contain RegEx characters.
      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.

    • 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.digitalarchitecture.api.ManageReferenceData
      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.digitalarchitecture.api.ManageReferenceData
      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.

    • getValidValuesAssignmentConsumers

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueAssignmentConsumerElement> getValidValuesAssignmentConsumers(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 consumers for a valid value.
      Specified by:
      getValidValuesAssignmentConsumers in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      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 referenceable 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.

    • getValidValuesAssignmentDefinition

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueAssignmentDefinitionElement> getValidValuesAssignmentDefinition(String userId, String referenceableGUID, 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 values assigned to referenceable element.
      Specified by:
      getValidValuesAssignmentDefinition in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user
      referenceableGUID - unique identifier of anchoring referenceable
      startFrom - paging starting point
      pageSize - maximum number of return values.
      Returns:
      list of valid value consumer 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.

    • getValidValuesImplementationAssets

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueImplAssetElement> getValidValuesImplementationAssets(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 implementations for a valid value.
      Specified by:
      getValidValuesImplementationAssets in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      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 asset 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.

    • getValidValuesImplementationDefinitions

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueImplDefinitionElement> getValidValuesImplementationDefinitions(String userId, String assetGUID, 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 values defining the content of a reference data asset. This is always called from the assetHandler after it has checked that the asset is in the right zone.
      Specified by:
      getValidValuesImplementationDefinitions in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user
      assetGUID - unique identifier of asset 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.

    • getValidValueMappings

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValueMappingElement> getValidValueMappings(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 mappings for a valid value. These are other valid values from different valid value sets that are equivalent in some way. The association description covers the type of association.
      Specified by:
      getValidValueMappings in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      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 mappings to other 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.

    • getValidValuesMappings

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ValidValuesMappingElement> getValidValuesMappings(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 mapping relationships associated with a valid value. These are other valid values from different valid value sets that are equivalent in some way. The association description covers the type of association.
      Specified by:
      getValidValuesMappings in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      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 mappings to other 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.

    • getReferenceValueAssignedItems

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ReferenceValueAssignmentItemElement> getReferenceValueAssignedItems(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 referenceables that have this valid value as a reference value.
      Specified by:
      getReferenceValueAssignedItems in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      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 referenceable 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.

    • getReferenceValueAssignments

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ReferenceValueAssignmentDefinitionElement> getReferenceValueAssignments(String userId, String referenceableGUID, 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 assigned reference values for a referenceable.
      Specified by:
      getReferenceValueAssignments in interface org.odpi.openmetadata.accessservices.digitalarchitecture.api.ManageReferenceData
      Parameters:
      userId - calling user
      referenceableGUID - unique identifier of assigned item
      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.