Interface SchemaManagerInterface

  • All Known Implementing Classes:
    APIManagerClient, DisplayApplicationClient, EventBrokerClient, FilesAndFoldersClient, SchemaManagerClient

    public interface SchemaManagerInterface
    SchemaManagerInterface defines the common methods for managing SchemaTypes and SchemaAttributes. It is incorporated in the EventBrokerInterface, ApplicationInterface and the APIManagerInterface. SchemaAttributes describe the data fields of the schema. If a schema attribute's type is simple (that is primitive, literal, enum or external, its details are passed with the schema attribute. Complex schema types (such as Maps, Choices) are constructed first and then their identifiers are attached to the schema attribute. SchemaTypes are used when creating complex schema structures that involve maps, choice and links to externally defined schemas that are, for example, part of a standard.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearCalculatedValue​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaElementGUID)
      Remove the calculated value designation from the schema element.
      void clearQueryTargetRelationship​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String derivedElementGUID, java.lang.String queryTargetGUID)
      Remove the query target relationship between two schema elements.
      void clearSchemaTypes​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaAttributeGUID)
      Remove the linked schema types from a schema attribute.
      java.lang.String createEnumSchemaType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, EnumSchemaTypeProperties schemaTypeProperties, java.lang.String validValuesSetGUID)
      Create a new metadata element to represent a schema type that has a fixed set of values that are described by a valid value set.
      java.lang.String createLiteralSchemaType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, LiteralSchemaTypeProperties schemaTypeProperties)
      Create a new metadata element to represent a schema type that has a fixed value.
      java.lang.String createMapSchemaType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, MapSchemaTypeProperties schemaTypeProperties, java.lang.String mapFromSchemaTypeGUID, java.lang.String mapToSchemaTypeGUID)
      Create a new metadata element to represent a schema type.
      java.lang.String createPrimitiveSchemaType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, PrimitiveSchemaTypeProperties schemaTypeProperties)
      Create a new metadata element to represent a primitive schema type such as a string, integer or character.
      java.lang.String createSchemaAttribute​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaElementGUID, SchemaAttributeProperties schemaAttributeProperties)
      Create a new metadata element to represent a schema attribute.
      java.lang.String createSchemaAttributeFromTemplate​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaElementGUID, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
      java.lang.String createSchemaTypeChoice​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, SchemaTypeChoiceProperties schemaTypeProperties, java.util.List<java.lang.String> schemaTypeOptionGUIDs)
      Create a new metadata element to represent a list of possible schema types that can be used for the attached schema attribute.
      java.lang.String createSchemaTypeFromTemplate​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a schema type using an existing metadata element as a template.
      java.lang.String createStructSchemaType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, StructSchemaTypeProperties schemaTypeProperties)
      Create a new metadata element to represent a schema type.
      java.util.List<SchemaAttributeElement> findSchemaAttributes​(java.lang.String userId, java.lang.String searchString, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of schema attribute metadata elements that contain the search string.
      java.util.List<SchemaTypeElement> findSchemaType​(java.lang.String userId, java.lang.String searchString, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of schema type metadata elements that contain the search string.
      java.util.List<ValidValueSetElement> findValidValueSet​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of valid value set metadata elements that contain the search string.
      java.util.List<SchemaAttributeElement> getNestedAttributes​(java.lang.String userId, java.lang.String parentSchemaElementGUID, int startFrom, int pageSize)
      Retrieve the list of schema attributes associated with a StructSchemaType or nested underneath a schema attribute.
      SchemaAttributeElement getSchemaAttributeByGUID​(java.lang.String userId, java.lang.String schemaAttributeGUID)
      Retrieve the schema attribute metadata element with the supplied unique identifier.
      java.util.List<SchemaAttributeElement> getSchemaAttributesByName​(java.lang.String userId, java.lang.String name, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of schema attribute metadata elements with a matching qualified or display name.
      SchemaTypeElement getSchemaTypeByGUID​(java.lang.String userId, java.lang.String schemaTypeGUID)
      Retrieve the schema type metadata element with the supplied unique identifier.
      java.util.List<SchemaTypeElement> getSchemaTypeByName​(java.lang.String userId, java.lang.String name, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of schema type metadata elements with a matching qualified or display name.
      SchemaTypeElement getSchemaTypeForElement​(java.lang.String userId, java.lang.String parentElementGUID, java.lang.String parentElementTypeName)
      Return the schema type associated with a specific open metadata element (data asset, process or port).
      ElementStub getSchemaTypeParent​(java.lang.String userId, java.lang.String schemaTypeGUID)
      Retrieve the header of the metadata element connected to a schema type.
      java.util.List<ValidValueSetElement> getValidValueSetByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of valid value set metadata elements with a matching qualified or display name.
      void removeSchemaAttribute​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaAttributeGUID)
      Remove the metadata element representing a schema attribute.
      void removeSchemaType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaTypeGUID)
      Remove the metadata element representing a schema type.
      void setupCalculatedValue​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaElementGUID, java.lang.String formula)
      Classify the schema element to indicate that it describes a calculated value.
      void setupQueryTargetRelationship​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String derivedElementGUID, java.lang.String queryTargetGUID, DerivedSchemaTypeQueryTargetProperties queryTargetProperties)
      Link two schema elements together to show a query target relationship.
      void setupSchemaType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String relationshipTypeName, java.lang.String schemaAttributeGUID, java.lang.String schemaTypeGUID)
      Connect a schema type to a schema attribute.
      void updateQueryTargetRelationship​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String derivedElementGUID, java.lang.String queryTargetGUID, DerivedSchemaTypeQueryTargetProperties queryTargetProperties)
      Update the relationship properties for the query target.
      void updateSchemaAttribute​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaAttributeGUID, boolean isMergeUpdate, SchemaAttributeProperties schemaAttributeProperties)
      Update the properties of the metadata element representing a schema attribute.
      void updateSchemaType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaTypeGUID, boolean isMergeUpdate, SchemaTypeProperties schemaTypeProperties)
      Update the metadata element representing a schema type.
    • Method Detail

      • createPrimitiveSchemaType

        java.lang.String createPrimitiveSchemaType​(java.lang.String userId,
                                                   java.lang.String externalSourceGUID,
                                                   java.lang.String externalSourceName,
                                                   PrimitiveSchemaTypeProperties schemaTypeProperties)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException
        Create a new metadata element to represent a primitive schema type such as a string, integer or character.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        schemaTypeProperties - properties about the schema type to store
        Returns:
        unique identifier of the new schema type
        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)
      • createLiteralSchemaType

        java.lang.String createLiteralSchemaType​(java.lang.String userId,
                                                 java.lang.String externalSourceGUID,
                                                 java.lang.String externalSourceName,
                                                 LiteralSchemaTypeProperties schemaTypeProperties)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Create a new metadata element to represent a schema type that has a fixed value.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        schemaTypeProperties - properties about the schema type to store
        Returns:
        unique identifier of the new schema type
        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)
      • createEnumSchemaType

        java.lang.String createEnumSchemaType​(java.lang.String userId,
                                              java.lang.String externalSourceGUID,
                                              java.lang.String externalSourceName,
                                              EnumSchemaTypeProperties schemaTypeProperties,
                                              java.lang.String validValuesSetGUID)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException
        Create a new metadata element to represent a schema type that has a fixed set of values that are described by a valid value set.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        schemaTypeProperties - properties about the schema type to store
        validValuesSetGUID - unique identifier of the valid values set to used
        Returns:
        unique identifier of the new schema type
        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)
      • createStructSchemaType

        java.lang.String createStructSchemaType​(java.lang.String userId,
                                                java.lang.String externalSourceGUID,
                                                java.lang.String externalSourceName,
                                                StructSchemaTypeProperties schemaTypeProperties)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException
        Create a new metadata element to represent a schema type.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        schemaTypeProperties - properties about the schema type to store
        Returns:
        unique identifier of the new schema type
        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)
      • createSchemaTypeChoice

        java.lang.String createSchemaTypeChoice​(java.lang.String userId,
                                                java.lang.String externalSourceGUID,
                                                java.lang.String externalSourceName,
                                                SchemaTypeChoiceProperties schemaTypeProperties,
                                                java.util.List<java.lang.String> schemaTypeOptionGUIDs)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException
        Create a new metadata element to represent a list of possible schema types that can be used for the attached schema attribute.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        schemaTypeProperties - properties about the schema type to store
        schemaTypeOptionGUIDs - unique identifier for the schema types to choose from
        Returns:
        unique identifier of the new schema type
        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)
      • createMapSchemaType

        java.lang.String createMapSchemaType​(java.lang.String userId,
                                             java.lang.String externalSourceGUID,
                                             java.lang.String externalSourceName,
                                             MapSchemaTypeProperties schemaTypeProperties,
                                             java.lang.String mapFromSchemaTypeGUID,
                                             java.lang.String mapToSchemaTypeGUID)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException
        Create a new metadata element to represent a schema type.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        schemaTypeProperties - properties about the schema type to store
        mapFromSchemaTypeGUID - unique identifier of the domain of the map
        mapToSchemaTypeGUID - unique identifier of the range of the map
        Returns:
        unique identifier of the new schema type
        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)
      • createSchemaTypeFromTemplate

        java.lang.String createSchemaTypeFromTemplate​(java.lang.String userId,
                                                      java.lang.String externalSourceGUID,
                                                      java.lang.String externalSourceName,
                                                      java.lang.String templateGUID,
                                                      TemplateProperties templateProperties)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException
        Create a new metadata element to represent a schema type using an existing metadata element as a template.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        templateGUID - unique identifier of the metadata element to copy
        templateProperties - properties that override the template
        Returns:
        unique identifier of the new schema type
        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)
      • updateSchemaType

        void updateSchemaType​(java.lang.String userId,
                              java.lang.String externalSourceGUID,
                              java.lang.String externalSourceName,
                              java.lang.String schemaTypeGUID,
                              boolean isMergeUpdate,
                              SchemaTypeProperties schemaTypeProperties)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
        Update the metadata element representing a schema type. It is possible to use the subtype property classes or set up specialized properties in extended properties.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        schemaTypeGUID - unique identifier of the metadata element to update
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        schemaTypeProperties - new properties for the 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)
      • removeSchemaType

        void removeSchemaType​(java.lang.String userId,
                              java.lang.String externalSourceGUID,
                              java.lang.String externalSourceName,
                              java.lang.String schemaTypeGUID)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
        Remove the metadata element representing a schema type.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        schemaTypeGUID - 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)
      • findSchemaType

        java.util.List<SchemaTypeElement> findSchemaType​(java.lang.String userId,
                                                         java.lang.String searchString,
                                                         java.lang.String typeName,
                                                         int startFrom,
                                                         int pageSize)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException
        Retrieve the list of schema type metadata elements that contain the search string. The search string is treated as a regular expression.
        Parameters:
        userId - calling user
        searchString - string to find in the properties
        typeName - optional type name for the schema type - used to restrict the search results
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of matching metadata elements
        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)
      • getSchemaTypeForElement

        SchemaTypeElement getSchemaTypeForElement​(java.lang.String userId,
                                                  java.lang.String parentElementGUID,
                                                  java.lang.String parentElementTypeName)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException
        Return the schema type associated with a specific open metadata element (data asset, process or port).
        Parameters:
        userId - calling user
        parentElementGUID - unique identifier of the open metadata element that this schema type is connected to
        parentElementTypeName - unique type name of the open metadata element that this schema type is connected to
        Returns:
        metadata element describing the schema type associated with the requested parent 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)
      • getSchemaTypeByName

        java.util.List<SchemaTypeElement> getSchemaTypeByName​(java.lang.String userId,
                                                              java.lang.String name,
                                                              java.lang.String typeName,
                                                              int startFrom,
                                                              int pageSize)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException
        Retrieve the list of schema type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Parameters:
        userId - calling user
        name - name to search for
        typeName - optional type name for the schema type - used to restrict the search results
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of matching metadata elements
        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)
      • createSchemaAttribute

        java.lang.String createSchemaAttribute​(java.lang.String userId,
                                               java.lang.String externalSourceGUID,
                                               java.lang.String externalSourceName,
                                               java.lang.String schemaElementGUID,
                                               SchemaAttributeProperties schemaAttributeProperties)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException
        Create a new metadata element to represent a schema attribute.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the schema attribute is nested underneath
        schemaAttributeProperties - properties for the schema attribute
        Returns:
        unique identifier of the new metadata element for the schema attribute
        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)
      • createSchemaAttributeFromTemplate

        java.lang.String createSchemaAttributeFromTemplate​(java.lang.String userId,
                                                           java.lang.String externalSourceGUID,
                                                           java.lang.String externalSourceName,
                                                           java.lang.String schemaElementGUID,
                                                           java.lang.String templateGUID,
                                                           TemplateProperties templateProperties)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException
        Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the schema attribute is connected to
        templateGUID - unique identifier of the metadata element to copy
        templateProperties - properties that override the template
        Returns:
        unique identifier of the new metadata element for the schema attribute
        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)
      • setupSchemaType

        void setupSchemaType​(java.lang.String userId,
                             java.lang.String externalSourceGUID,
                             java.lang.String externalSourceName,
                             java.lang.String relationshipTypeName,
                             java.lang.String schemaAttributeGUID,
                             java.lang.String schemaTypeGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
        Connect a schema type to a schema attribute.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        relationshipTypeName - name of relationship to create
        schemaAttributeGUID - unique identifier of the schema attribute
        schemaTypeGUID - unique identifier of the schema type to connect
        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)
      • clearSchemaTypes

        void clearSchemaTypes​(java.lang.String userId,
                              java.lang.String externalSourceGUID,
                              java.lang.String externalSourceName,
                              java.lang.String schemaAttributeGUID)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
        Remove the linked schema types from a schema attribute.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        schemaAttributeGUID - unique identifier of the schema attribute
        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)
      • updateSchemaAttribute

        void updateSchemaAttribute​(java.lang.String userId,
                                   java.lang.String externalSourceGUID,
                                   java.lang.String externalSourceName,
                                   java.lang.String schemaAttributeGUID,
                                   boolean isMergeUpdate,
                                   SchemaAttributeProperties schemaAttributeProperties)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
        Update the properties of the metadata element representing a schema attribute.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        schemaAttributeGUID - unique identifier of the schema attribute to update
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        schemaAttributeProperties - new properties for the schema attribute
        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)
      • removeSchemaAttribute

        void removeSchemaAttribute​(java.lang.String userId,
                                   java.lang.String externalSourceGUID,
                                   java.lang.String externalSourceName,
                                   java.lang.String schemaAttributeGUID)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
        Remove the metadata element representing a schema attribute.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        schemaAttributeGUID - 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)
      • findSchemaAttributes

        java.util.List<SchemaAttributeElement> findSchemaAttributes​(java.lang.String userId,
                                                                    java.lang.String searchString,
                                                                    java.lang.String typeName,
                                                                    int startFrom,
                                                                    int pageSize)
                                                             throws InvalidParameterException,
                                                                    UserNotAuthorizedException,
                                                                    PropertyServerException
        Retrieve the list of schema attribute metadata elements that contain the search string. The search string is treated as a regular expression.
        Parameters:
        userId - calling user
        searchString - string to find in the properties
        typeName - optional type name for the schema attribute - used to restrict the search results
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of matching metadata elements
        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)
      • getNestedAttributes

        java.util.List<SchemaAttributeElement> getNestedAttributes​(java.lang.String userId,
                                                                   java.lang.String parentSchemaElementGUID,
                                                                   int startFrom,
                                                                   int pageSize)
                                                            throws InvalidParameterException,
                                                                   UserNotAuthorizedException,
                                                                   PropertyServerException
        Retrieve the list of schema attributes associated with a StructSchemaType or nested underneath a schema attribute.
        Parameters:
        userId - calling user
        parentSchemaElementGUID - unique identifier of the schema element of interest
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of associated metadata elements
        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)
      • getSchemaAttributesByName

        java.util.List<SchemaAttributeElement> getSchemaAttributesByName​(java.lang.String userId,
                                                                         java.lang.String name,
                                                                         java.lang.String typeName,
                                                                         int startFrom,
                                                                         int pageSize)
                                                                  throws InvalidParameterException,
                                                                         UserNotAuthorizedException,
                                                                         PropertyServerException
        Retrieve the list of schema attribute metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Parameters:
        userId - calling user
        name - name to search for
        typeName - optional type name for the schema type - used to restrict the search results
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of matching metadata elements
        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)
      • setupCalculatedValue

        void setupCalculatedValue​(java.lang.String userId,
                                  java.lang.String externalSourceGUID,
                                  java.lang.String externalSourceName,
                                  java.lang.String schemaElementGUID,
                                  java.lang.String formula)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Classify the schema element to indicate that it describes a calculated value.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        schemaElementGUID - unique identifier of the metadata element to update
        formula - formula for calculating the value - this may contain placeholders that are identified by the queryIds used in the queryTarget relationships
        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)
      • clearCalculatedValue

        void clearCalculatedValue​(java.lang.String userId,
                                  java.lang.String externalSourceGUID,
                                  java.lang.String externalSourceName,
                                  java.lang.String schemaElementGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Remove the calculated value designation from the schema element.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        schemaElementGUID - unique identifier of the metadata element to update
        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)
      • setupQueryTargetRelationship

        void setupQueryTargetRelationship​(java.lang.String userId,
                                          java.lang.String externalSourceGUID,
                                          java.lang.String externalSourceName,
                                          java.lang.String derivedElementGUID,
                                          java.lang.String queryTargetGUID,
                                          DerivedSchemaTypeQueryTargetProperties queryTargetProperties)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Link two schema elements together to show a query target relationship. The query target provides data values to calculate a derived value.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        derivedElementGUID - unique identifier of the derived schema element
        queryTargetGUID - unique identifier of the query target schema element
        queryTargetProperties - properties for the query target relationship
        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)
      • updateQueryTargetRelationship

        void updateQueryTargetRelationship​(java.lang.String userId,
                                           java.lang.String externalSourceGUID,
                                           java.lang.String externalSourceName,
                                           java.lang.String derivedElementGUID,
                                           java.lang.String queryTargetGUID,
                                           DerivedSchemaTypeQueryTargetProperties queryTargetProperties)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Update the relationship properties for the query target.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        derivedElementGUID - unique identifier of the derived schema element
        queryTargetGUID - unique identifier of the query target schema element
        queryTargetProperties - properties for the query target relationship
        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)
      • clearQueryTargetRelationship

        void clearQueryTargetRelationship​(java.lang.String userId,
                                          java.lang.String externalSourceGUID,
                                          java.lang.String externalSourceName,
                                          java.lang.String derivedElementGUID,
                                          java.lang.String queryTargetGUID)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Remove the query target relationship between two schema elements.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        derivedElementGUID - unique identifier of the derived schema element
        queryTargetGUID - unique identifier of the query target schema 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)