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 or replace the asset origin classification to an asset.
void	addSecurityTags(String userId, String assetGUID, String assetElementGUID, List<String> securityLabels, Map<String,Object> securityProperties) Add or replace the security tags for an asset or one of its elements.
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 an attribute in the schema).
void	addTemplateClassification(String userId, String assetGUID, String name, String description, Map<String,String> additionalProperties) Classify an asset as suitable to be used as a template for cataloguing assets of a similar types.
void	publishAsset(String userId, String assetGUID) Update the zones for a specific asset to the zone list specified in the publishZones.
void	removeAssetOrigin(String userId, String assetGUID) Remove the asset origin classification to an asset.
void	removeSecurityTags(String userId, String assetGUID, String assetElementGUID) Remove the security tags classification to an asset or one of its elements.
void	removeSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID) Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).
void	removeTemplateClassification(String userId, String assetGUID) Remove the classification that indicates that this asset can be used as a template.
void	updateAssetOwner(String userId, String assetGUID, String ownerId, OwnerType ownerType) Update the owner information for a specific asset.
void	updateAssetZones(String userId, String assetGUID, List<String> assetZones) Update the zones for a specific asset.
void	withdrawAsset(String userId, String assetGUID) Update the zones for a specific asset to the zone list specified in the defaultZones.

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 an attribute 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. If null then the assetGUID is used.

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeSemanticAssignment

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

Remove the 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. If null then the assetGUID is used.

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 or replace 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

removeAssetOrigin

void removeAssetOrigin(String userId,
                       String assetGUID)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

Remove the asset origin classification to an asset.

Parameters:

userId - calling user

assetGUID - unique identifier of asset

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

publishAsset

void publishAsset(String userId,
                  String assetGUID)
           throws InvalidParameterException,
                  UserNotAuthorizedException,
                  PropertyServerException

Update the zones for a specific asset to the zone list specified in the publishZones.

Parameters:

userId - calling user

assetGUID - unique identifier for the asset to update

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

withdrawAsset

void withdrawAsset(String userId,
                   String assetGUID)
            throws InvalidParameterException,
                   UserNotAuthorizedException,
                   PropertyServerException

Update the zones for a specific asset to the zone list specified in the defaultZones.

Parameters:

userId - calling user

assetGUID - unique identifier for the asset to update

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateAssetZones

void updateAssetZones(String userId,
                      String assetGUID,
                      List<String> assetZones)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Update the zones for a specific asset.

Parameters:

userId - calling user

assetGUID - unique identifier for the asset to update

assetZones - list of zones for the asset - these values override the current values - null means belongs to no zones.

Throws:

InvalidParameterException - guid or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateAssetOwner

void updateAssetOwner(String userId,
                      String assetGUID,
                      String ownerId,
                      OwnerType ownerType)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Update the owner information for a specific asset.

Parameters:

userId - calling user

assetGUID - unique identifier for the asset to update

ownerId - userId or profileGUID of the owner - or null to clear the field

ownerType - indicator of the type of Id provides above - or null to clear the field

Throws:

InvalidParameterException - userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addSecurityTags

void addSecurityTags(String userId,
                     String assetGUID,
                     String assetElementGUID,
                     List<String> securityLabels,
                     Map<String,Object> securityProperties)
              throws InvalidParameterException,
                     UserNotAuthorizedException,
                     PropertyServerException

Add or replace the security tags for an asset or one of its elements.

Parameters:

userId - calling user

assetGUID - unique identifier of asset

assetElementGUID - element to link it to - its type must inherit from Referenceable. If null then the assetGUID is used.

securityLabels - list of security labels defining the security characteristics of the element

securityProperties - Descriptive labels describing the security properties of the element

Throws:

InvalidParameterException - asset or element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeSecurityTags

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

Remove the security tags classification to an asset or one of its elements.

Parameters:

userId - calling user

assetGUID - unique identifier of asset

assetElementGUID - element where the security tags need to be removed. If null then the assetGUID is used

Throws:

InvalidParameterException - asset or element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addTemplateClassification

void addTemplateClassification(String userId,
                               String assetGUID,
                               String name,
                               String description,
                               Map<String,String> additionalProperties)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Classify an asset as suitable to be used as a template for cataloguing assets of a similar types.

Parameters:

userId - calling user

assetGUID - unique identifier of the asset to classify

name - name of the template

description - description of when, where and how to use the template

additionalProperties - any additional properties

Throws:

InvalidParameterException - asset or element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeTemplateClassification

void removeTemplateClassification(String userId,
                                  String assetGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Remove the classification that indicates that this asset can be used as a template.

Parameters:

userId - calling user

assetGUID - unique identifier of the asset to declassify

Throws:

InvalidParameterException - asset or element not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem