Package org.odpi.openmetadata.accessservices.assetmanager.api

Interface ValidValuesExchangeInterface

  • public interface ValidValuesExchangeInterface
    The ValidValuesExchangeInterface supports the exchanges of valid values and reference data.

    • Method Detail

      • createValidValueSet

        String createValidValueSet​(String userId,
                           String assetManagerGUID,
                           String assetManagerName,
                           String validValueExternalIdentifier,
                           String validValueExternalIdentifierName,
                           String validValueExternalIdentifierUsage,
                           String validValueExternalIdentifierSource,
                           KeyPattern validValueExternalIdentifierKeyPattern,
                           Map<String,​String> mappingProperties,
                           ValidValueProperties validValueProperties)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        validValueExternalIdentifier - unique identifier of the valid value in the external asset manager
        validValueExternalIdentifierName - name of property for the external identifier in the external asset manager
        validValueExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager
        validValueExternalIdentifierSource - component that issuing this request.
        validValueExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)
        mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata
        validValueProperties - properties to store
        Returns:
        unique identifier for the new set
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.

      • createValidValueDefinition

        String createValidValueDefinition​(String userId,
                                  String setGUID,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  String validValueExternalIdentifier,
                                  String validValueExternalIdentifierName,
                                  String validValueExternalIdentifierUsage,
                                  String validValueExternalIdentifierSource,
                                  KeyPattern validValueExternalIdentifierKeyPattern,
                                  Map<String,​String> mappingProperties,
                                  ValidValueProperties validValueProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Create a new valid value definition.
        Parameters:
        userId - calling user.
        setGUID - unique identifier of the set to attach this to.
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        validValueExternalIdentifier - unique identifier of the valid value in the external asset manager
        validValueExternalIdentifierName - name of property for the external identifier in the external asset manager
        validValueExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager
        validValueExternalIdentifierSource - component that issuing this request.
        validValueExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)
        mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata
        validValueProperties - properties to store
        Returns:
        unique identifier for the new definition
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.

      • updateValidValue

        void updateValidValue​(String userId,
                      String assetManagerGUID,
                      String assetManagerName,
                      String validValueGUID,
                      String validValueExternalIdentifier,
                      boolean isMergeUpdate,
                      ValidValueProperties validValueProperties)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      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.
        Parameters:
        userId - calling user.
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        validValueGUID - unique identifier of the valid value.
        validValueExternalIdentifier - unique identifier of the valid value in the external asset manager
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        validValueProperties - properties to store
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.

      • removeValidValue

        void removeValidValue​(String userId,
                      String assetManagerGUID,
                      String assetManagerName,
                      String validValueGUID,
                      String validValueExternalIdentifier)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException
        Remove the valid value form the repository. All links to it are deleted too.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        validValueGUID - unique identifier of the valid value.
        validValueExternalIdentifier - unique identifier of the valid value in the external asset manager
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.

      • attachValidValueToSet

        void attachValidValueToSet​(String userId,
                           String assetManagerGUID,
                           String assetManagerName,
                           String setGUID,
                           String validValueGUID)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           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.
        Parameters:
        userId - calling user.
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        setGUID - unique identifier of the set.
        validValueGUID - unique identifier of the valid value to add to the set.
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.

      • getValidValueByName

        List<ValidValueElement> getValidValueByName​(String userId,
                                            String assetManagerGUID,
                                            String assetManagerName,
                                            String validValueName,
                                            int startFrom,
                                            int pageSize)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException
        Retrieve a specific valid value from the repository. Duplicates may be returned if multiple valid values have been assigned the same qualified name.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        validValueName - qualified name of the valid value.
        startFrom - starting element (used in paging through large result sets)
        pageSize - maximum number of results to return
        Returns:
        Valid value beans
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.

      • findValidValues

        List<ValidValueElement> findValidValues​(String userId,
                                        String assetManagerGUID,
                                        String assetManagerName,
                                        String searchString,
                                        int startFrom,
                                        int pageSize)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
        Locate valid values that match the search string. It considers the names, description, scope, usage and preferred value.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        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:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.

      • getSetsForValidValue

        List<ValidValueElement> getSetsForValidValue​(String userId,
                                             String assetManagerGUID,
                                             String assetManagerName,
                                             String validValueGUID,
                                             int startFrom,
                                             int pageSize)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException
        Page through the list of valid value sets that a valid value definition/set belongs to.
        Parameters:
        userId - calling user.
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        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:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.