Interface AssetOnboardingValidValues

  • All Known Implementing Classes:
    ValidValuesAssetOwner

    public interface AssetOnboardingValidValues
    AssetOnboardingValidValues 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.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void attachValidValueToSet​(java.lang.String userId, java.lang.String setGUID, java.lang.String validValueGUID, boolean isDefaultValue)
      Create a link between a valid value set or definition and a set.
      java.lang.String createValidValueDefinition​(java.lang.String userId, java.lang.String setGUID, boolean isDefaultValue, java.lang.String qualifiedName, java.lang.String displayName, java.lang.String description, java.lang.String usage, java.lang.String scope, java.lang.String preferredValue, java.util.Map<java.lang.String,​java.lang.String> additionalProperties, java.util.Map<java.lang.String,​java.lang.Object> extendedProperties)
      Create a new valid value definition.
      java.lang.String createValidValueSet​(java.lang.String userId, java.lang.String qualifiedName, java.lang.String displayName, java.lang.String description, java.lang.String usage, java.lang.String scope, java.util.Map<java.lang.String,​java.lang.String> additionalProperties, java.util.Map<java.lang.String,​java.lang.Object> extendedProperties)
      Create a new valid value set.
      void deleteValidValue​(java.lang.String userId, java.lang.String validValueGUID, java.lang.String qualifiedName)
      Remove the valid value form the repository.
      void detachValidValueFromSet​(java.lang.String userId, java.lang.String setGUID, java.lang.String validValueGUID)
      Remove the link between a valid value and a set it is a member of.
      java.util.List<ValidValueElement> findValidValues​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Locate valid values that match the search string.
      java.util.List<ValidValueElement> getSetsForValidValue​(java.lang.String userId, java.lang.String validValueGUID, int startFrom, int pageSize)
      Page through the list of valid value sets that a valid value definition/set belongs to.
      ValidValueElement getValidValueByGUID​(java.lang.String userId, java.lang.String validValueGUID)
      Retrieve a specific valid value from the repository.
      java.util.List<ValidValueElement> getValidValueByName​(java.lang.String userId, java.lang.String validValueName, int startFrom, int pageSize)
      Retrieve a specific valid value from the repository.
      java.util.List<ValidValueElement> getValidValueSetMembers​(java.lang.String userId, java.lang.String validValueSetGUID, int startFrom, int pageSize)
      Page through the members of a valid value set.
      void updateValidValue​(java.lang.String userId, java.lang.String validValueGUID, java.lang.String qualifiedName, java.lang.String displayName, java.lang.String description, java.lang.String usage, java.lang.String scope, java.lang.String preferredValue, boolean isDeprecated, java.util.Map<java.lang.String,​java.lang.String> additionalProperties, java.util.Map<java.lang.String,​java.lang.Object> extendedProperties)
      Update the properties of the valid value.
    • Method Detail

      • createValidValueSet

        java.lang.String createValidValueSet​(java.lang.String userId,
                                             java.lang.String qualifiedName,
                                             java.lang.String displayName,
                                             java.lang.String description,
                                             java.lang.String usage,
                                             java.lang.String scope,
                                             java.util.Map<java.lang.String,​java.lang.String> additionalProperties,
                                             java.util.Map<java.lang.String,​java.lang.Object> extendedProperties)
                                      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.
        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.
        extendedProperties - properties that need to be populated into a subtype.
        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

        java.lang.String createValidValueDefinition​(java.lang.String userId,
                                                    java.lang.String setGUID,
                                                    boolean isDefaultValue,
                                                    java.lang.String qualifiedName,
                                                    java.lang.String displayName,
                                                    java.lang.String description,
                                                    java.lang.String usage,
                                                    java.lang.String scope,
                                                    java.lang.String preferredValue,
                                                    java.util.Map<java.lang.String,​java.lang.String> additionalProperties,
                                                    java.util.Map<java.lang.String,​java.lang.Object> extendedProperties)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException
        Create a new valid value definition.
        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.
        scope - what is the scope of the values.
        preferredValue - the value that should be used in an implementation if possible.
        additionalProperties - additional properties for this definition.
        extendedProperties - properties that need to be populated into a subtype.
        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​(java.lang.String userId,
                              java.lang.String validValueGUID,
                              java.lang.String qualifiedName,
                              java.lang.String displayName,
                              java.lang.String description,
                              java.lang.String usage,
                              java.lang.String scope,
                              java.lang.String preferredValue,
                              boolean isDeprecated,
                              java.util.Map<java.lang.String,​java.lang.String> additionalProperties,
                              java.util.Map<java.lang.String,​java.lang.Object> extendedProperties)
                       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.
        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.
        isDeprecated - is this value deprecated?
        additionalProperties - additional properties for this valid value.
        extendedProperties - properties that need to be populated into a subtype.
        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.
      • deleteValidValue

        void deleteValidValue​(java.lang.String userId,
                              java.lang.String validValueGUID,
                              java.lang.String qualifiedName)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
        Remove the valid value form the repository. All links to it are deleted too.
        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:
        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​(java.lang.String userId,
                                   java.lang.String setGUID,
                                   java.lang.String validValueGUID,
                                   boolean isDefaultValue)
                            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.
        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:
        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

        java.util.List<ValidValueElement> getValidValueByName​(java.lang.String userId,
                                                              java.lang.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
        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.