org.odpi.openmetadata.accessservices.governanceengine.api

Interface MetadataElementInterface

public interface MetadataElementInterface

Method Summary

Modifier and Type	Method and Description
void	classifyMetadataElementInStore(String userId, String metadataElementGUID, String classificationName, Date effectiveFrom, Date effectiveTo, ElementProperties properties) Add a new classification to the metadata element.
String	createMetadataElementInStore(String userId, String metadataElementTypeName, ElementStatus initialStatus, Date effectiveFrom, Date effectiveTo, ElementProperties properties, String templateGUID) Create a new metadata element in the metadata store.
String	createRelatedElementsInStore(String userId, String relationshipTypeName, String metadataElement1GUID, String metadataElement2GUID, Date effectiveFrom, Date effectiveTo, ElementProperties properties) Create a relationship between two metadata elements.
void	deleteMetadataElementInStore(String userId, String metadataElementGUID) Delete a specific metadata element.
void	deleteRelatedElementsInStore(String userId, String relationshipGUID) Delete a relationship between two metadata elements.
List<OpenMetadataElement>	findMetadataElements(String userId, String metadataElementTypeName, List<String> metadataElementSubtypeName, SearchProperties searchProperties, List<ElementStatus> limitResultsByStatus, SearchClassifications matchClassifications, String sequencingProperty, SequencingOrder sequencingOrder, int startFrom, int pageSize) Return a list of metadata elements that match the supplied criteria.
List<OpenMetadataElement>	findMetadataElementsWithString(String userId, String searchString, int startFrom, int pageSize) Retrieve the metadata elements that contain the requested string.
List<RelatedMetadataElements>	findRelationshipsBetweenMetadataElements(String userId, String relationshipTypeName, SearchProperties searchProperties, String sequencingProperty, SequencingOrder sequencingOrder, int startFrom, int pageSize) Return a list of relationships that match the requested conditions.
OpenMetadataElement	getMetadataElementByGUID(String userId, String elementGUID) Retrieve the metadata element using its unique identifier.
OpenMetadataElement	getMetadataElementByUniqueName(String userId, String uniqueName, String uniquePropertyName) Retrieve the metadata element using its unique name (typically the qualified name).
String	getMetadataElementGUIDByUniqueName(String userId, String uniqueName, String uniquePropertyName) Retrieve the unique identifier of a metadata element using its unique name (typically the qualified name).
List<RelatedMetadataElement>	getRelatedMetadataElements(String userId, String elementGUID, int startingAtEnd, String relationshipTypeName, int startFrom, int pageSize) Retrieve the metadata elements connected to the supplied element.
void	reclassifyMetadataElementInStore(String userId, String metadataElementGUID, String classificationName, boolean replaceProperties, ElementProperties properties) Update the properties of a classification that is currently attached to a specific metadata element.
void	unclassifyMetadataElementInStore(String userId, String metadataElementGUID, String classificationName) Remove the named classification from a specific metadata element.
void	updateClassificationStatusInStore(String userId, String metadataElementGUID, String classificationName, Date effectiveFrom, Date effectiveTo) Update the effectivity dates of a specific classification attached to a metadata element.
void	updateMetadataElementInStore(String userId, String metadataElementGUID, boolean replaceProperties, ElementProperties properties) Update the properties of a specific metadata element.
void	updateMetadataElementStatusInStore(String userId, String metadataElementGUID, ElementStatus newElementStatus, Date effectiveFrom, Date effectiveTo) Update the status of specific metadata element.
void	updateRelatedElementsInStore(String userId, String relationshipGUID, boolean replaceProperties, ElementProperties properties) Update the properties associated with a relationship.
void	updateRelatedElementsStatusInStore(String userId, String relationshipGUID, Date effectiveFrom, Date effectiveTo) Update the effectivity dates of a specific relationship between metadata elements.

Method Detail

getMetadataElementByGUID

OpenMetadataElement getMetadataElementByGUID(String userId,
                                             String elementGUID)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Retrieve the metadata element using its unique identifier.

Parameters:

userId - caller's userId

elementGUID - unique identifier for the metadata element

Returns:

metadata element properties

Throws:

InvalidParameterException - the unique identifier is null or not known.

UserNotAuthorizedException - the governance action service is not able to access the element

PropertyServerException - there is a problem accessing the metadata store

getMetadataElementByUniqueName

OpenMetadataElement getMetadataElementByUniqueName(String userId,
                                                   String uniqueName,
                                                   String uniquePropertyName)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Retrieve the metadata element using its unique name (typically the qualified name).

Parameters:

userId - caller's userId

uniqueName - unique name for the metadata element

uniquePropertyName - name of property name to test in the open metadata element - if null "qualifiedName" is used

Returns:

metadata element properties

Throws:

InvalidParameterException - the unique identifier is null or not known.

UserNotAuthorizedException - the governance action service is not able to access the element

PropertyServerException - there is a problem accessing the metadata store

getMetadataElementGUIDByUniqueName

String getMetadataElementGUIDByUniqueName(String userId,
                                          String uniqueName,
                                          String uniquePropertyName)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Retrieve the unique identifier of a metadata element using its unique name (typically the qualified name).

Parameters:

userId - caller's userId

uniqueName - unique name for the metadata element

uniquePropertyName - name of property name to test in the open metadata element - if null "qualifiedName" is used

Returns:

metadata element unique identifier (guid)

Throws:

InvalidParameterException - the unique identifier is null or not known.

UserNotAuthorizedException - the governance action service is not able to access the element

PropertyServerException - there is a problem accessing the metadata store

findMetadataElementsWithString

List<OpenMetadataElement> findMetadataElementsWithString(String userId,
                                                         String searchString,
                                                         int startFrom,
                                                         int pageSize)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException

Retrieve the metadata elements that contain the requested string.

Parameters:

userId - caller's userId

searchString - name to retrieve

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements (or null if no elements match the name)

Throws:

InvalidParameterException - the qualified name is null

UserNotAuthorizedException - the governance action service is not able to access the element

PropertyServerException - there is a problem accessing the metadata store

getRelatedMetadataElements

List<RelatedMetadataElement> getRelatedMetadataElements(String userId,
                                                        String elementGUID,
                                                        int startingAtEnd,
                                                        String relationshipTypeName,
                                                        int startFrom,
                                                        int pageSize)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

Retrieve the metadata elements connected to the supplied element.

Parameters:

userId - caller's userId

elementGUID - unique identifier for the starting metadata element

startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)

relationshipTypeName - type name of relationships to follow (or null for all)

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of related elements

Throws:

InvalidParameterException - the unique identifier is null or not known; the relationship type is invalid

UserNotAuthorizedException - the governance action service is not able to access the elements

PropertyServerException - there is a problem accessing the metadata store

findMetadataElements

List<OpenMetadataElement> findMetadataElements(String userId,
                                               String metadataElementTypeName,
                                               List<String> metadataElementSubtypeName,
                                               SearchProperties searchProperties,
                                               List<ElementStatus> limitResultsByStatus,
                                               SearchClassifications matchClassifications,
                                               String sequencingProperty,
                                               SequencingOrder sequencingOrder,
                                               int startFrom,
                                               int pageSize)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Return a list of metadata elements that match the supplied criteria. The results can be returned over many pages.

Parameters:

userId - caller's userId

metadataElementTypeName - type of interest (null means any element type)

metadataElementSubtypeName - optional list of the subtypes of the metadataElementTypeName to include in the search results. Null means all subtypes.

searchProperties - Optional list of entity property conditions to match.

limitResultsByStatus - By default, entities in all statuses (other than DELETE) are returned. However, it is possible to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all status values.

matchClassifications - Optional list of classifications to match.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

a list of elements matching the supplied criteria; null means no matching elements in the metadata store.

Throws:

InvalidParameterException - one of the search parameters are is invalid

UserNotAuthorizedException - the governance action service is not able to access the elements

PropertyServerException - there is a problem accessing the metadata store

findRelationshipsBetweenMetadataElements

List<RelatedMetadataElements> findRelationshipsBetweenMetadataElements(String userId,
                                                                       String relationshipTypeName,
                                                                       SearchProperties searchProperties,
                                                                       String sequencingProperty,
                                                                       SequencingOrder sequencingOrder,
                                                                       int startFrom,
                                                                       int pageSize)
                                                                throws InvalidParameterException,
                                                                       UserNotAuthorizedException,
                                                                       PropertyServerException

Return a list of relationships that match the requested conditions. The results can be received as a series of pages.

Parameters:

userId - caller's userId

relationshipTypeName - relationship's type. Null means all types (but may be slow so not recommended).

searchProperties - Optional list of relationship property conditions to match.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

a list of relationships. Null means no matching relationships.

Throws:

InvalidParameterException - one of the search parameters are is invalid

UserNotAuthorizedException - the governance action service is not able to access the elements

PropertyServerException - there is a problem accessing the metadata store

createMetadataElementInStore

String createMetadataElementInStore(String userId,
                                    String metadataElementTypeName,
                                    ElementStatus initialStatus,
                                    Date effectiveFrom,
                                    Date effectiveTo,
                                    ElementProperties properties,
                                    String templateGUID)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Create a new metadata element in the metadata store. The type name comes from the open metadata types. The selected type also controls the names and types of the properties that are allowed. This version of the method allows access to advanced features such as multiple states and effectivity dates.

Parameters:

userId - caller's userId

metadataElementTypeName - type name of the new metadata element

initialStatus - initial status of the metadata element

effectiveFrom - the date when this element is active - null for active on creation

effectiveTo - the date when this element becomes inactive - null for active until deleted

properties - properties of the new metadata element

templateGUID - the unique identifier of the existing asset to copy (this will copy all of the attachments such as nested content, schema connection etc)

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - the type name, status or one of the properties is invalid

UserNotAuthorizedException - the governance action service is not authorized to create this type of element

PropertyServerException - there is a problem with the metadata store

updateMetadataElementInStore

void updateMetadataElementInStore(String userId,
                                  String metadataElementGUID,
                                  boolean replaceProperties,
                                  ElementProperties properties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Update the properties of a specific metadata element. The properties must match the type definition associated with the metadata element when it was created. However, it is possible to update a few properties, or replace all of them by the value used in the replaceProperties flag.

Parameters:

userId - caller's userId

metadataElementGUID - unique identifier of the metadata element to update

replaceProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.

properties - new properties for the metadata element

Throws:

InvalidParameterException - either the unique identifier or the properties are invalid in some way

UserNotAuthorizedException - the governance action service is not authorized to update this element

PropertyServerException - there is a problem with the metadata store

updateMetadataElementStatusInStore

void updateMetadataElementStatusInStore(String userId,
                                        String metadataElementGUID,
                                        ElementStatus newElementStatus,
                                        Date effectiveFrom,
                                        Date effectiveTo)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Update the status of specific metadata element. The new status must match a status value that is defined for the element's type assigned when it was created. The effectivity dates control the visibility of the element through specific APIs.

Parameters:

userId - caller's userId

metadataElementGUID - unique identifier of the metadata element to update

newElementStatus - new status value - or null to leave as is

effectiveFrom - the date when this element is active - null for active now

effectiveTo - the date when this element becomes inactive - null for active until deleted

Throws:

InvalidParameterException - either the unique identifier or the status are invalid in some way

UserNotAuthorizedException - the governance action service is not authorized to update this element

PropertyServerException - there is a problem with the metadata store

deleteMetadataElementInStore

void deleteMetadataElementInStore(String userId,
                                  String metadataElementGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Delete a specific metadata element.

Parameters:

userId - caller's userId

metadataElementGUID - unique identifier of the metadata element to update

Throws:

InvalidParameterException - the unique identifier is null or invalid in some way

UserNotAuthorizedException - the governance action service is not authorized to delete this element

PropertyServerException - there is a problem with the metadata store

classifyMetadataElementInStore

void classifyMetadataElementInStore(String userId,
                                    String metadataElementGUID,
                                    String classificationName,
                                    Date effectiveFrom,
                                    Date effectiveTo,
                                    ElementProperties properties)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Add a new classification to the metadata element. Note that only one classification with the same name can be attached to a metadata element.

Parameters:

userId - caller's userId

metadataElementGUID - unique identifier of the metadata element to update

classificationName - name of the classification to add (if the classification is already present then use reclassify)

effectiveFrom - the date when this classification is active - null for active now

effectiveTo - the date when this classification becomes inactive - null for active until deleted

properties - properties to store in the new classification. These must conform to the valid properties associated with the classification name

Throws:

InvalidParameterException - the unique identifier or classification name is null or invalid in some way; properties do not match the valid properties associated with the classification's type definition

UserNotAuthorizedException - the governance action service is not authorized to update this element

PropertyServerException - there is a problem with the metadata store

reclassifyMetadataElementInStore

void reclassifyMetadataElementInStore(String userId,
                                      String metadataElementGUID,
                                      String classificationName,
                                      boolean replaceProperties,
                                      ElementProperties properties)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Update the properties of a classification that is currently attached to a specific metadata element.

Parameters:

userId - caller's userId

metadataElementGUID - unique identifier of the metadata element to update

classificationName - unique name of the classification to update

replaceProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.

properties - new properties for the classification

Throws:

InvalidParameterException - the unique identifier or classification name is null or invalid in some way; properties do not match the valid properties associated with the classification's type definition

UserNotAuthorizedException - the governance action service is not authorized to update this element/classification

PropertyServerException - there is a problem with the metadata store

updateClassificationStatusInStore

void updateClassificationStatusInStore(String userId,
                                       String metadataElementGUID,
                                       String classificationName,
                                       Date effectiveFrom,
                                       Date effectiveTo)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Update the effectivity dates of a specific classification attached to a metadata element. The effectivity dates control the visibility of the classification through specific APIs.

Parameters:

userId - caller's userId

metadataElementGUID - unique identifier of the metadata element to update

classificationName - unique name of the classification to update

effectiveFrom - the date when this element is active - null for active now

effectiveTo - the date when this element becomes inactive - null for active until deleted

Throws:

InvalidParameterException - either the unique identifier or the status are invalid in some way

UserNotAuthorizedException - the governance action service is not authorized to update this element

PropertyServerException - there is a problem with the metadata store

unclassifyMetadataElementInStore

void unclassifyMetadataElementInStore(String userId,
                                      String metadataElementGUID,
                                      String classificationName)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Remove the named classification from a specific metadata element.

Parameters:

userId - caller's userId

metadataElementGUID - unique identifier of the metadata element to update

classificationName - unique name of the classification to remove

Throws:

InvalidParameterException - the unique identifier or classification name is null or invalid in some way

UserNotAuthorizedException - the governance action service is not authorized to remove this classification

PropertyServerException - there is a problem with the metadata store

createRelatedElementsInStore

String createRelatedElementsInStore(String userId,
                                    String relationshipTypeName,
                                    String metadataElement1GUID,
                                    String metadataElement2GUID,
                                    Date effectiveFrom,
                                    Date effectiveTo,
                                    ElementProperties properties)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Create a relationship between two metadata elements. It is important to put the right element at each end of the relationship according to the type definition since this will affect how the relationship is interpreted.

Parameters:

userId - caller's userId

relationshipTypeName - name of the type of relationship to create. This will determine the types of metadata elements that can be related and the properties that can be associated with this relationship.

metadataElement1GUID - unique identifier of the metadata element at end 1 of the relationship

metadataElement2GUID - unique identifier of the metadata element at end 2 of the relationship

effectiveFrom - the date when this element is active - null for active now

effectiveTo - the date when this element becomes inactive - null for active until deleted

properties - the properties of the relationship

Returns:

unique identifier of the new relationship

Throws:

InvalidParameterException - the unique identifier's of the metadata elements are null or invalid in some way; the properties are not valid for this type of relationship

UserNotAuthorizedException - the governance action service is not authorized to create this type of relationship

PropertyServerException - there is a problem with the metadata store

updateRelatedElementsInStore

void updateRelatedElementsInStore(String userId,
                                  String relationshipGUID,
                                  boolean replaceProperties,
                                  ElementProperties properties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Update the properties associated with a relationship.

Parameters:

userId - caller's userId

relationshipGUID - unique identifier of the relationship to update

replaceProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.

properties - new properties for the relationship

Throws:

InvalidParameterException - the unique identifier of the relationship is null or invalid in some way; the properties are not valid for this type of relationship

UserNotAuthorizedException - the governance action service is not authorized to update this relationship

PropertyServerException - there is a problem with the metadata store

updateRelatedElementsStatusInStore

void updateRelatedElementsStatusInStore(String userId,
                                        String relationshipGUID,
                                        Date effectiveFrom,
                                        Date effectiveTo)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Update the effectivity dates of a specific relationship between metadata elements. The effectivity dates control the visibility of the classification through specific APIs.

Parameters:

userId - caller's userId

relationshipGUID - unique identifier of the relationship to update

effectiveFrom - the date when this element is active - null for active now

effectiveTo - the date when this element becomes inactive - null for active until deleted

Throws:

InvalidParameterException - either the unique identifier or the status are invalid in some way

UserNotAuthorizedException - the governance action service is not authorized to update this element

PropertyServerException - there is a problem with the metadata store

deleteRelatedElementsInStore

void deleteRelatedElementsInStore(String userId,
                                  String relationshipGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Delete a relationship between two metadata elements.

Parameters:

userId - caller's userId

relationshipGUID - unique identifier of the relationship to delete

Throws:

InvalidParameterException - the unique identifier of the relationship is null or invalid in some way

UserNotAuthorizedException - the governance action service is not authorized to delete this relationship

PropertyServerException - there is a problem with the metadata store