Package org.odpi.openmetadata.commonservices.generichandlers

Class AssetBuilder

java.lang.Object

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericBuilder

org.odpi.openmetadata.commonservices.generichandlers.ReferenceableBuilder

org.odpi.openmetadata.commonservices.generichandlers.AssetBuilder

Direct Known Subclasses:

ProcessBuilder

public class AssetBuilder
extends ReferenceableBuilder

AssetBuilder creates the parts of a root repository entity for an asset.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableBuilder

qualifiedName

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericBuilder

errorHandler, existingClassifications, extendedProperties, instanceStatus, newClassifications, repositoryHelper, serverName, serviceName, templateProperties, typeGUID, typeName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AssetBuilder(String qualifiedName, String technicalName, String technicalDescription, Map<String,String> additionalProperties, String typeGUID, String typeName, Map<String,Object> extendedProperties, InstanceStatus initialStatus, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Constructor supporting all entity properties.
protected	AssetBuilder(String qualifiedName, String technicalName, String technicalDescription, Map<String,String> additionalProperties, String typeGUID, String typeName, Map<String,Object> extendedProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Constructor supporting all entity properties.
protected	AssetBuilder(String typeGUID, String typeName, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Subtype constructor used when working with classifications
protected	AssetBuilder(OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Creation constructor used when working with classifications

Method Summary

Modifier and Type	Method	Description
InstanceProperties	getInstanceProperties(String methodName)	Return the supplied bean properties in an InstanceProperties object.
protected void	setAssetOwnership(String userId, String owner, int ownerType, String methodName)	Set up the AssetOwnership classification for this entity.
protected void	setAssetZones(String userId, List<String> zoneMembership, String methodName)	Set up the AssetZones classification for this entity.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableBuilder

getQualifiedName, setMemento, setOwnershipClassification, setSecurityTags, setTemplate

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericBuilder

getEntityClassificationProperties, getEntityClassifications, getExistingEntityClassificationHeader, getInstanceProperties, getInstanceStatus, getTypeGUID, getTypeName, setAnchors, setClassification, setEffectivityDates, setEffectivityDates, setLatestChange, setTemplateClassifications, updateInstanceProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssetBuilder

protected AssetBuilder(OMRSRepositoryHelper repositoryHelper,
                       String serviceName,
                       String serverName)

Creation constructor used when working with classifications

Parameters:

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

AssetBuilder

protected AssetBuilder(String typeGUID,
                       String typeName,
                       OMRSRepositoryHelper repositoryHelper,
                       String serviceName,
                       String serverName)

Subtype constructor used when working with classifications

Parameters:

typeGUID - unique identifier for the type of this asset

typeName - unique name for the type of this asset

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

AssetBuilder

protected AssetBuilder(String qualifiedName,
                       String technicalName,
                       String technicalDescription,
                       Map<String,String> additionalProperties,
                       String typeGUID,
                       String typeName,
                       Map<String,Object> extendedProperties,
                       OMRSRepositoryHelper repositoryHelper,
                       String serviceName,
                       String serverName)

Constructor supporting all entity properties. (Classifications are added separately.)

Parameters:

qualifiedName - unique name

technicalName - new value for the name

technicalDescription - new description for the asset

additionalProperties - additional properties

typeGUID - unique identifier for the type of this asset

typeName - unique name for the type of this asset

extendedProperties - properties from the subtype

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

AssetBuilder

protected AssetBuilder(String qualifiedName,
                       String technicalName,
                       String technicalDescription,
                       Map<String,String> additionalProperties,
                       String typeGUID,
                       String typeName,
                       Map<String,Object> extendedProperties,
                       InstanceStatus initialStatus,
                       OMRSRepositoryHelper repositoryHelper,
                       String serviceName,
                       String serverName)

Constructor supporting all entity properties. (Classifications are added separately.)

Parameters:

qualifiedName - unique name

technicalName - new value for the name

technicalDescription - new description for the asset

additionalProperties - additional properties

typeGUID - unique identifier for the type of this asset

typeName - unique name for the type of this asset

extendedProperties - properties from the subtype

initialStatus - status used to create the asset

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

Method Detail

setAssetZones

protected void setAssetZones(String userId,
                             List<String> zoneMembership,
                             String methodName)
                      throws InvalidParameterException

Set up the AssetZones classification for this entity. This method overrides an previously defined AssetZones classification for this entity.

Parameters:

userId - calling user

zoneMembership - list of zone names for the zones this asset is a member of

methodName - calling method

Throws:

InvalidParameterException - AssetZones is not supported in the local repository, or any repository connected by an open metadata repository cohort

setAssetOwnership

protected void setAssetOwnership(String userId,
                                 String owner,
                                 int ownerType,
                                 String methodName)
                          throws InvalidParameterException

Set up the AssetOwnership classification for this entity. This method overrides an previously defined AssetOwnership classification for this entity.

Parameters:

userId - calling user

owner - name of the owner.

ownerType - Enum ordinal for type of owner - 0=userId; 1= profileId; 99=other.

methodName - calling method

Throws:

InvalidParameterException - AssetOwnership is not supported in the local repository, or any repository connected by an open metadata repository cohort

getInstanceProperties

public InstanceProperties getInstanceProperties(String methodName)
                                         throws InvalidParameterException

Return the supplied bean properties in an InstanceProperties object.

Overrides:

getInstanceProperties in class ReferenceableBuilder

Parameters:

methodName - name of the calling method

Returns:

InstanceProperties object

Throws:

InvalidParameterException - there is a problem with the properties