org.odpi.openmetadata.accessservices.assetmanager.api

Interface SchemaExchangeInterface

All Known Subinterfaces:

DataAssetExchangeInterface, LineageExchangeInterface

public interface SchemaExchangeInterface

SchemaExchangeInterface defines the common methods for managing schemas. It is incorporated in the DataAssetExchangeInterface and the LineageExchangeInterface.

Method Summary

Modifier and Type	Method and Description
void	clearColumnAsPrimaryKey(String userId, String assetManagerGUID, String assetManagerName, String schemaAttributeGUID, String schemaAttributeExternalIdentifier) Remove the primary key designation from the schema attribute.
void	clearForeignKeyRelationship(String userId, String assetManagerGUID, String assetManagerName, String primaryKeyGUID, String foreignKeyGUID) Remove the foreign key relationship between two schema elements.
void	clearSchemaElementAsCalculatedValue(String userId, String assetManagerGUID, String assetManagerName, String schemaElementGUID, String schemaElementExternalIdentifier) Remove the calculated value designation from the schema element.
void	clearSchemaTypeParent(String userId, String assetManagerGUID, String assetManagerName, String schemaTypeGUID, String parentElementGUID, String parentElementTypeName) Remove the relationship between a schema type and its parent data asset, process or port.
String	createSchemaAttribute(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String schemaElementGUID, String schemaAttributeExternalIdentifier, String schemaAttributeExternalIdentifierName, String schemaAttributeExternalIdentifierUsage, String schemaAttributeExternalIdentifierSource, KeyPattern schemaAttributeExternalIdentifierKeyPattern, Map<String,String> mappingProperties, SchemaAttributeProperties schemaAttributeProperties) Create a new metadata element to represent a schema attribute.
String	createSchemaAttributeFromTemplate(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String schemaElementGUID, String templateGUID, String schemaAttributeExternalIdentifier, String schemaAttributeExternalIdentifierName, String schemaAttributeExternalIdentifierUsage, String schemaAttributeExternalIdentifierSource, KeyPattern schemaAttributeExternalIdentifierKeyPattern, Map<String,String> mappingProperties, TemplateProperties templateProperties) Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
String	createSchemaType(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String schemaTypeExternalIdentifier, String schemaTypeExternalIdentifierName, String schemaTypeExternalIdentifierUsage, String schemaTypeExternalIdentifierSource, KeyPattern schemaTypeExternalIdentifierKeyPattern, Map<String,String> mappingProperties, SchemaTypeProperties schemaTypeProperties) Create a new metadata element to represent a schema type.
String	createSchemaTypeFromTemplate(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String templateGUID, String schemaTypeExternalIdentifier, String schemaTypeExternalIdentifierName, String schemaTypeExternalIdentifierUsage, String schemaTypeExternalIdentifierSource, KeyPattern schemaTypeExternalIdentifierKeyPattern, Map<String,String> mappingProperties, TemplateProperties templateProperties) Create a new metadata element to represent a schema type using an existing metadata element as a template.
List<SchemaAttributeElement>	findSchemaAttributes(String userId, String assetManagerGUID, String assetManagerName, String searchString, int startFrom, int pageSize) Retrieve the list of schema attribute metadata elements that contain the search string.
List<SchemaTypeElement>	findSchemaType(String userId, String assetManagerGUID, String assetManagerName, String searchString, int startFrom, int pageSize) Retrieve the list of schema type metadata elements that contain the search string.
List<SchemaAttributeElement>	getAttributesForSchemaType(String userId, String assetManagerGUID, String assetManagerName, String schemaTypeGUID, int startFrom, int pageSize) Retrieve the list of schema attributes associated with a schemaType.
SchemaAttributeElement	getSchemaAttributeByGUID(String userId, String assetManagerGUID, String assetManagerName, String schemaAttributeGUID) Retrieve the schema attribute metadata element with the supplied unique identifier.
List<SchemaAttributeElement>	getSchemaAttributesByName(String userId, String assetManagerGUID, String assetManagerName, String name, int startFrom, int pageSize) Retrieve the list of schema attribute metadata elements with a matching qualified or display name.
SchemaTypeElement	getSchemaTypeByGUID(String userId, String assetManagerGUID, String assetManagerName, String schemaTypeGUID) Retrieve the schema type metadata element with the supplied unique identifier.
List<SchemaTypeElement>	getSchemaTypeByName(String userId, String assetManagerGUID, String assetManagerName, String name, int startFrom, int pageSize) Retrieve the list of schema type metadata elements with a matching qualified or display name.
SchemaTypeElement	getSchemaTypeForElement(String userId, String assetManagerGUID, String assetManagerName, String parentElementGUID, String parentElementTypeName) Return the schema type associated with a specific open metadata element (data asset, process or port).
ElementHeader	getSchemaTypeParent(String userId, String assetManagerGUID, String assetManagerName, String schemaTypeGUID) Retrieve the header of the metadata element connected to a schema type.
void	removeSchemaAttribute(String userId, String assetManagerGUID, String assetManagerName, String schemaAttributeGUID, String schemaAttributeExternalIdentifier) Remove the metadata element representing a schema attribute.
void	removeSchemaType(String userId, String assetManagerGUID, String assetManagerName, String schemaTypeGUID, String schemaTypeExternalIdentifier) Remove the metadata element representing a schema type.
void	setSchemaElementAsCalculatedValue(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String schemaElementGUID, String schemaElementExternalIdentifier, String formula) Classify the schema type (or attribute if type is embedded) to indicate that it is a calculated value.
void	setupColumnAsPrimaryKey(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String schemaAttributeGUID, String schemaAttributeExternalIdentifier, String primaryKeyName, KeyPattern primaryKeyPattern) Classify the column schema attribute to indicate that it describes a primary key.
void	setupForeignKeyRelationship(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String primaryKeyGUID, String foreignKeyGUID, ForeignKeyProperties foreignKeyProperties) Link two schema attributes together to show a foreign key relationship.
void	setupSchemaTypeParent(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String schemaTypeGUID, String parentElementGUID, String parentElementTypeName) Connect a schema type to a data asset, process or port.
void	updateForeignKeyRelationship(String userId, String assetManagerGUID, String assetManagerName, String primaryKeyGUID, String foreignKeyGUID, ForeignKeyProperties foreignKeyProperties) Update the relationship properties for the query target.
void	updateSchemaAttribute(String userId, String assetManagerGUID, String assetManagerName, String schemaAttributeGUID, String schemaAttributeExternalIdentifier, boolean isMergeUpdate, SchemaAttributeProperties schemaAttributeProperties) Update the properties of the metadata element representing a schema attribute.
void	updateSchemaType(String userId, String assetManagerGUID, String assetManagerName, String schemaTypeGUID, String schemaTypeExternalIdentifier, boolean isMergeUpdate, SchemaTypeProperties schemaTypeProperties) Update the metadata element representing a schema type.

Method Detail

createSchemaType

String createSchemaType(String userId,
                        String assetManagerGUID,
                        String assetManagerName,
                        boolean assetManagerIsHome,
                        String schemaTypeExternalIdentifier,
                        String schemaTypeExternalIdentifierName,
                        String schemaTypeExternalIdentifierUsage,
                        String schemaTypeExternalIdentifierSource,
                        KeyPattern schemaTypeExternalIdentifierKeyPattern,
                        Map<String,String> mappingProperties,
                        SchemaTypeProperties schemaTypeProperties)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Create a new metadata element to represent a schema type.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this schema element

schemaTypeExternalIdentifier - unique identifier of the schema type in the external asset manager

schemaTypeExternalIdentifierName - name of property for the external identifier in the external asset manager

schemaTypeExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager

schemaTypeExternalIdentifierSource - component that issuing this request.

schemaTypeExternalIdentifierKeyPattern - 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

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)

createSchemaTypeFromTemplate

String createSchemaTypeFromTemplate(String userId,
                                    String assetManagerGUID,
                                    String assetManagerName,
                                    boolean assetManagerIsHome,
                                    String templateGUID,
                                    String schemaTypeExternalIdentifier,
                                    String schemaTypeExternalIdentifierName,
                                    String schemaTypeExternalIdentifierUsage,
                                    String schemaTypeExternalIdentifierSource,
                                    KeyPattern schemaTypeExternalIdentifierKeyPattern,
                                    Map<String,String> mappingProperties,
                                    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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this schema attribute

templateGUID - unique identifier of the metadata element to copy

schemaTypeExternalIdentifier - unique identifier of the schema type in the external asset manager

schemaTypeExternalIdentifierName - name of property for the external identifier in the external asset manager

schemaTypeExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager

schemaTypeExternalIdentifierSource - component that issuing this request.

schemaTypeExternalIdentifierKeyPattern - 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

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(String userId,
                      String assetManagerGUID,
                      String assetManagerName,
                      String schemaTypeGUID,
                      String schemaTypeExternalIdentifier,
                      boolean isMergeUpdate,
                      SchemaTypeProperties schemaTypeProperties)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Update the metadata element representing a schema type.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

schemaTypeGUID - unique identifier of the metadata element to update

schemaTypeExternalIdentifier - unique identifier of the schema type in the external asset manager

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)

setupSchemaTypeParent

void setupSchemaTypeParent(String userId,
                           String assetManagerGUID,
                           String assetManagerName,
                           boolean assetManagerIsHome,
                           String schemaTypeGUID,
                           String parentElementGUID,
                           String parentElementTypeName)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Connect a schema type to a data asset, process or port.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this relationship

schemaTypeGUID - unique identifier of the schema type to connect

parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to

parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to

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)

clearSchemaTypeParent

void clearSchemaTypeParent(String userId,
                           String assetManagerGUID,
                           String assetManagerName,
                           String schemaTypeGUID,
                           String parentElementGUID,
                           String parentElementTypeName)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Remove the relationship between a schema type and its parent data asset, process or port.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

schemaTypeGUID - unique identifier of the schema type to connect

parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to

parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to

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(String userId,
                      String assetManagerGUID,
                      String assetManagerName,
                      String schemaTypeGUID,
                      String schemaTypeExternalIdentifier)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Remove the metadata element representing a schema type.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

schemaTypeGUID - unique identifier of the metadata element to remove

schemaTypeExternalIdentifier - unique identifier of the schema type in the external asset manager

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

List<SchemaTypeElement> findSchemaType(String userId,
                                       String assetManagerGUID,
                                       String assetManagerName,
                                       String searchString,
                                       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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

searchString - string to find in the properties

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(String userId,
                                          String assetManagerGUID,
                                          String assetManagerName,
                                          String parentElementGUID,
                                          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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to

parentElementTypeName - unique type name of the open metadata element that this schema type is to be 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

List<SchemaTypeElement> getSchemaTypeByName(String userId,
                                            String assetManagerGUID,
                                            String assetManagerName,
                                            String name,
                                            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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

name - name to search for

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)

getSchemaTypeByGUID

SchemaTypeElement getSchemaTypeByGUID(String userId,
                                      String assetManagerGUID,
                                      String assetManagerName,
                                      String schemaTypeGUID)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Retrieve the schema type metadata element with the supplied unique identifier.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

schemaTypeGUID - unique identifier of the requested metadata element

Returns:

requested 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)

getSchemaTypeParent

ElementHeader getSchemaTypeParent(String userId,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  String schemaTypeGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Retrieve the header of the metadata element connected to a schema type.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

schemaTypeGUID - unique identifier of the requested metadata element

Returns:

header for parent element (data asset, process, port)

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

String createSchemaAttribute(String userId,
                             String assetManagerGUID,
                             String assetManagerName,
                             boolean assetManagerIsHome,
                             String schemaElementGUID,
                             String schemaAttributeExternalIdentifier,
                             String schemaAttributeExternalIdentifierName,
                             String schemaAttributeExternalIdentifierUsage,
                             String schemaAttributeExternalIdentifierSource,
                             KeyPattern schemaAttributeExternalIdentifierKeyPattern,
                             Map<String,String> mappingProperties,
                             SchemaAttributeProperties schemaAttributeProperties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Create a new metadata element to represent a schema attribute.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this schema attribute

schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the schema attribute is connected to

schemaAttributeExternalIdentifier - unique identifier of the schema attribute in the external asset manager

schemaAttributeExternalIdentifierName - name of property for the external identifier in the external asset manager

schemaAttributeExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager

schemaAttributeExternalIdentifierSource - component that issuing this request.

schemaAttributeExternalIdentifierKeyPattern - 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

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

String createSchemaAttributeFromTemplate(String userId,
                                         String assetManagerGUID,
                                         String assetManagerName,
                                         boolean assetManagerIsHome,
                                         String schemaElementGUID,
                                         String templateGUID,
                                         String schemaAttributeExternalIdentifier,
                                         String schemaAttributeExternalIdentifierName,
                                         String schemaAttributeExternalIdentifierUsage,
                                         String schemaAttributeExternalIdentifierSource,
                                         KeyPattern schemaAttributeExternalIdentifierKeyPattern,
                                         Map<String,String> mappingProperties,
                                         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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this schema attribute

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

schemaAttributeExternalIdentifier - unique identifier of the schema attribute in the external asset manager

schemaAttributeExternalIdentifierName - name of property for the external identifier in the external asset manager

schemaAttributeExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager

schemaAttributeExternalIdentifierSource - component that issuing this request.

schemaAttributeExternalIdentifierKeyPattern - 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

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)

updateSchemaAttribute

void updateSchemaAttribute(String userId,
                           String assetManagerGUID,
                           String assetManagerName,
                           String schemaAttributeGUID,
                           String schemaAttributeExternalIdentifier,
                           boolean isMergeUpdate,
                           SchemaAttributeProperties schemaAttributeProperties)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Update the properties of the metadata element representing a schema attribute.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

schemaAttributeGUID - unique identifier of the schema attribute to update

schemaAttributeExternalIdentifier - unique identifier of the schema attribute in the external asset manager

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)

setSchemaElementAsCalculatedValue

void setSchemaElementAsCalculatedValue(String userId,
                                       String assetManagerGUID,
                                       String assetManagerName,
                                       boolean assetManagerIsHome,
                                       String schemaElementGUID,
                                       String schemaElementExternalIdentifier,
                                       String formula)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Classify the schema type (or attribute if type is embedded) to indicate that it is a calculated 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

assetManagerIsHome - ensure that only the asset manager can update this classification

schemaElementGUID - unique identifier of the metadata element to update

schemaElementExternalIdentifier - unique identifier of the schema element in the external asset manager

formula - description of the logic that maps data values to

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)

clearSchemaElementAsCalculatedValue

void clearSchemaElementAsCalculatedValue(String userId,
                                         String assetManagerGUID,
                                         String assetManagerName,
                                         String schemaElementGUID,
                                         String schemaElementExternalIdentifier)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Remove the calculated value designation from the schema element.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

schemaElementGUID - unique identifier of the metadata element to update

schemaElementExternalIdentifier - unique identifier of the schema element in the external asset manager

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)

setupColumnAsPrimaryKey

void setupColumnAsPrimaryKey(String userId,
                             String assetManagerGUID,
                             String assetManagerName,
                             boolean assetManagerIsHome,
                             String schemaAttributeGUID,
                             String schemaAttributeExternalIdentifier,
                             String primaryKeyName,
                             KeyPattern primaryKeyPattern)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Classify the column schema attribute to indicate that it describes a primary key.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this classification

schemaAttributeGUID - unique identifier of the metadata element to update

schemaAttributeExternalIdentifier - unique identifier of the schema attribute in the external asset manager

primaryKeyName - name of the primary key (if different from the column name)

primaryKeyPattern - key pattern used to maintain the primary key

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)

clearColumnAsPrimaryKey

void clearColumnAsPrimaryKey(String userId,
                             String assetManagerGUID,
                             String assetManagerName,
                             String schemaAttributeGUID,
                             String schemaAttributeExternalIdentifier)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Remove the primary key designation from the schema attribute.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

schemaAttributeGUID - unique identifier of the metadata element to update

schemaAttributeExternalIdentifier - unique identifier of the schema attribute in the external asset manager

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)

setupForeignKeyRelationship

void setupForeignKeyRelationship(String userId,
                                 String assetManagerGUID,
                                 String assetManagerName,
                                 boolean assetManagerIsHome,
                                 String primaryKeyGUID,
                                 String foreignKeyGUID,
                                 ForeignKeyProperties foreignKeyProperties)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Link two schema attributes together to show a foreign key relationship.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this relationship

primaryKeyGUID - unique identifier of the derived schema element

foreignKeyGUID - unique identifier of the query target schema element

foreignKeyProperties - properties for the foreign key 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)

updateForeignKeyRelationship

void updateForeignKeyRelationship(String userId,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  String primaryKeyGUID,
                                  String foreignKeyGUID,
                                  ForeignKeyProperties foreignKeyProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Update the relationship properties for the query target.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

primaryKeyGUID - unique identifier of the derived schema element

foreignKeyGUID - unique identifier of the query target schema element

foreignKeyProperties - properties for the foreign key 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)

clearForeignKeyRelationship

void clearForeignKeyRelationship(String userId,
                                 String assetManagerGUID,
                                 String assetManagerName,
                                 String primaryKeyGUID,
                                 String foreignKeyGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Remove the foreign key relationship between two schema elements.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

primaryKeyGUID - unique identifier of the derived schema element

foreignKeyGUID - 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)

removeSchemaAttribute

void removeSchemaAttribute(String userId,
                           String assetManagerGUID,
                           String assetManagerName,
                           String schemaAttributeGUID,
                           String schemaAttributeExternalIdentifier)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Remove the metadata element representing a schema attribute.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

schemaAttributeGUID - unique identifier of the metadata element to remove

schemaAttributeExternalIdentifier - unique identifier of the schema attribute in the external asset manager

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

List<SchemaAttributeElement> findSchemaAttributes(String userId,
                                                  String assetManagerGUID,
                                                  String assetManagerName,
                                                  String searchString,
                                                  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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

searchString - string to find in the properties

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)

getAttributesForSchemaType

List<SchemaAttributeElement> getAttributesForSchemaType(String userId,
                                                        String assetManagerGUID,
                                                        String assetManagerName,
                                                        String schemaTypeGUID,
                                                        int startFrom,
                                                        int pageSize)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

Retrieve the list of schema attributes associated with a schemaType.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

schemaTypeGUID - unique identifier of the schemaType 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

List<SchemaAttributeElement> getSchemaAttributesByName(String userId,
                                                       String assetManagerGUID,
                                                       String assetManagerName,
                                                       String name,
                                                       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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

name - name to search for

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)

getSchemaAttributeByGUID

SchemaAttributeElement getSchemaAttributeByGUID(String userId,
                                                String assetManagerGUID,
                                                String assetManagerName,
                                                String schemaAttributeGUID)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Retrieve the schema attribute metadata element with the supplied unique identifier.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

schemaAttributeGUID - unique identifier of the requested metadata element

Returns:

matching 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)