Interface ValidValueManagementInterface

  • All Known Implementing Classes:
    ValidValueManagement

    public interface ValidValueManagementInterface
    The ValidValueManagementInterface provides methods for managing valid values.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearReferenceValueTag​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, java.lang.String validValueGUID)
      Remove a reference value assignment relationship between an element and a valid value.
      void clearValidValueMember​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String validValueSetGUID, java.lang.String validValueMemberGUID)
      Remove a membership relationship between a validValue and a validValueSet that it belongs to.
      void clearValidValues​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, java.lang.String validValueGUID)
      Remove a valid value assignment relationship between an element and a valid value.
      java.lang.String createValidValue​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, ValidValueProperties validValueProperties)
      Create a new metadata element to represent the validValue.
      java.util.List<ValidValueElement> findValidValues​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of metadata elements that contain the search string.
      java.util.List<ValidValueElement> getAllValidValues​(java.lang.String userId, int startFrom, int pageSize)
      Retrieve the list of valid values.
      java.util.List<RelatedElement> getAssigneesOfReferenceValue​(java.lang.String userId, java.lang.String validValueGUID, int startFrom, int pageSize)
      Return information about the person roles linked to a validValue.
      java.util.List<RelatedElement> getConsumersOfValidValue​(java.lang.String userId, java.lang.String validValueGUID, int startFrom, int pageSize)
      Return information about the consumers linked to a valid value.
      java.util.List<ValidValueElement> getReferenceValues​(java.lang.String userId, java.lang.String elementGUID, int startFrom, int pageSize)
      Return information about the valid values linked as reference value tags to an element..
      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 the validValue metadata element with the supplied unique identifier.
      java.util.List<ValidValueElement> getValidValuesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of metadata elements with a matching qualified or display name.
      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.
      ValidValueElement getValidValuesForConsumer​(java.lang.String userId, java.lang.String elementGUID)
      Return information about the valid value set linked to an element as its set of valid values.
      void removeValidValue​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String validValueGUID)
      Remove the metadata element representing a validValue.
      void setupReferenceValueTag​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, ReferenceValueAssignmentProperties properties, java.lang.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​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String validValueSetGUID, ValidValueMembershipProperties properties, java.lang.String validValueMemberGUID)
      Create a membership relationship between a validValue and a validValueSet that it belongs to.
      void setupValidValues​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, ValidValueAssignmentProperties properties, java.lang.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​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String validValueGUID, boolean isMergeUpdate, ValidValueProperties validValueProperties)
      Update the metadata element representing a validValue.
    • Method Detail

      • createValidValue

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

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

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

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

        void setupValidValues​(java.lang.String userId,
                              java.lang.String externalSourceGUID,
                              java.lang.String externalSourceName,
                              java.lang.String elementGUID,
                              ValidValueAssignmentProperties properties,
                              java.lang.String validValueGUID)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
        Create a valid value assignment relationship between an element and a valid value (typically, a valid value set) to show that the valid value defines the values that can be stored in the data item that the element represents.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        elementGUID - unique identifier of the element
        properties - describes the permissions that the role has in the validValue
        validValueGUID - unique identifier of the valid value
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearValidValues

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

        void setupReferenceValueTag​(java.lang.String userId,
                                    java.lang.String externalSourceGUID,
                                    java.lang.String externalSourceName,
                                    java.lang.String elementGUID,
                                    ReferenceValueAssignmentProperties properties,
                                    java.lang.String validValueGUID)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
        Create a reference value assignment relationship between an element and a valid value to show that the valid value is a semiformal tag/classification.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        elementGUID - unique identifier of the element
        properties - describes the quality of the assignment
        validValueGUID - unique identifier of the valid value
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearReferenceValueTag

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

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