org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders

Class GlossaryTermBuilder

java.lang.Object

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders.RootBuilder

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders.ReferenceableBuilder

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders.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.ocf.metadatamanagement.builders.ReferenceableBuilder

qualifiedName

Fields inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders.RootBuilder

classifications, errorHandler, repositoryHelper, serverName, serviceName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
InstanceProperties	getInstanceProperties(String methodName) Return the supplied bean properties in an InstanceProperties object.
InstanceProperties	getNameInstanceProperties(String methodName) Return the supplied bean properties that represent a name in an InstanceProperties object.
InstanceProperties	getQualifiedNameInstanceProperties(String methodName) Return the supplied bean properties that represent a name in an InstanceProperties object.
InstanceProperties	getSearchInstanceProperties(String methodName) Return the supplied bean properties that represent a name in an InstanceProperties object.

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders.RootBuilder

getEntityClassifications, setClassifications

Methods inherited from class java.lang.Object

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

Constructor Detail

GlossaryTermBuilder

public GlossaryTermBuilder(String qualifiedName,
                           String displayName,
                           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

serviceName - name of this OMAS

serverName - name of local server

GlossaryTermBuilder

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

Constructor supporting all properties.

Parameters:

qualifiedName - unique name

displayName - new value for the display name.

summary - short description

description - new description for the glossary term.

examples - example

abbreviation - abbreviation

usage - usage guidance

additionalProperties - additional properties

extendedProperties - properties from the subtype.

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

Method Detail

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

getQualifiedNameInstanceProperties

public InstanceProperties getQualifiedNameInstanceProperties(String methodName)

Return the supplied bean properties that represent a name in an InstanceProperties object.

Overrides:

getQualifiedNameInstanceProperties in class ReferenceableBuilder

Parameters:

methodName - name of the calling method

Returns:

InstanceProperties object

getNameInstanceProperties

public InstanceProperties getNameInstanceProperties(String methodName)

Return the supplied bean properties that represent a name in an InstanceProperties object.

Overrides:

getNameInstanceProperties in class ReferenceableBuilder

Parameters:

methodName - name of the calling method

Returns:

InstanceProperties object

getSearchInstanceProperties

public InstanceProperties getSearchInstanceProperties(String methodName)

Return the supplied bean properties that represent a name in an InstanceProperties object.

Parameters:

methodName - name of the calling method

Returns:

InstanceProperties object