Package org.odpi.openmetadata.commonservices.generichandlers

Class GlossaryTermBuilder

java.lang.Object

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericBuilder

org.odpi.openmetadata.commonservices.generichandlers.ReferenceableBuilder

org.odpi.openmetadata.commonservices.generichandlers.GlossaryTermBuilder

public class GlossaryTermBuilder
extends ReferenceableBuilder

GlossaryTermBuilder is able to build the properties for a GlossaryTerm entity from a GlossaryTerm bean.

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

Constructor	Description
GlossaryTermBuilder(String qualifiedName, String displayName, List<String> aliases, String summary, String description, String examples, String abbreviation, String usage, String publishVersionIdentifier, Map<String,String> additionalProperties, Map<String,Object> extendedProperties, InstanceStatus initialStatus, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Constructor supporting all properties.
GlossaryTermBuilder(String qualifiedName, String displayName, List<String> aliases, String description, String summary, String examples, String abbreviation, String usage, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Constructor when basic properties are known.

Method Summary

Modifier and Type	Method	Description
InstanceProperties	getInstanceProperties(String methodName)	Return the supplied bean properties in an InstanceProperties object.

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

getMementoProperties, getQualifiedName, setMemento, setOwnershipClassification, setSecurityTags, setTemplate

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

getEntityClassifications, getInstanceProperties, getInstanceStatus, getTypeGUID, getTypeName, isClassificationSet, setAnchors, setAnchors, setClassification, setEffectivityDates, setEffectivityDates, setTemplateClassifications, setTemplateSubstitute, updateInstanceProperties

Methods inherited from class java.lang.Object

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

Constructor Details

GlossaryTermBuilder

public GlossaryTermBuilder(String qualifiedName,
 String displayName,
 List<String> aliases,
 String description,
 String summary,
 String examples,
 String abbreviation,
 String usage,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String serverName)

Constructor when basic properties are known.

Parameters:

qualifiedName - unique name

repositoryHelper - helper methods

displayName - display name of glossary term

aliases - alternative names for the glossary term

description - new description for the glossary term.

summary - short description

examples - example

abbreviation - abbreviation

usage - usage guidance

serviceName - name of this OMAS

serverName - name of local server

GlossaryTermBuilder

public GlossaryTermBuilder(String qualifiedName,
 String displayName,
 List<String> aliases,
 String summary,
 String description,
 String examples,
 String abbreviation,
 String usage,
 String publishVersionIdentifier,
 Map<String,String> additionalProperties,
 Map<String,Object> extendedProperties,
 InstanceStatus initialStatus,
 OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String serverName)

Constructor supporting all properties.

Parameters:

qualifiedName - unique name

displayName - new value for the display name.

aliases - alternative names for the glossary term

summary - short description

description - new description for the glossary term.

examples - example

abbreviation - abbreviation

usage - usage guidance

publishVersionIdentifier - user controlled version identifier

additionalProperties - additional properties

extendedProperties - properties from the subtype.

initialStatus - glossary term status to use when the object is created

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

Method Details

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