org.odpi.openmetadata.accessservices.assetowner.api

Interface AssetClassificationInterface

public interface AssetClassificationInterface

The AssetClassificationInterface is used by the asset owner to add classifications and detailed definitions to the asset. Typically this interface is used after the discovery services have explored the asset's content and created helpful annotations to guide the asset owner.

Method Summary

Modifier and Type	Method and Description
void	addAssetOrigin(String userId, String assetGUID, String organizationGUID, String businessCapabilityGUID, Map<String,String> otherOriginValues) Add the asset origin classification to an asset.
void	addSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID) Create a simple relationship between a glossary term and an element in an Asset description (typically a field in the schema).

Method Detail

addSemanticAssignment

void addSemanticAssignment(String userId,
                           String assetGUID,
                           String glossaryTermGUID,
                           String assetElementGUID)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Create a simple relationship between a glossary term and an element in an Asset description (typically a field in the schema).

Parameters:

userId - calling user

assetGUID - unique identifier of asset

glossaryTermGUID - unique identifier of the glossary term

assetElementGUID - element to link it to - its type must inherit from Referenceable.

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addAssetOrigin

void addAssetOrigin(String userId,
                    String assetGUID,
                    String organizationGUID,
                    String businessCapabilityGUID,
                    Map<String,String> otherOriginValues)
             throws InvalidParameterException,
                    UserNotAuthorizedException,
                    PropertyServerException

Add the asset origin classification to an asset.

Parameters:

userId - calling user

assetGUID - unique identifier of asset

organizationGUID - Unique identifier (GUID) of the organization where this asset originated from - or null

businessCapabilityGUID - Unique identifier (GUID) of the business capability where this asset originated from.

otherOriginValues - Descriptive labels describing origin of the asset

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem