Package org.odpi.openmetadata.accessservices.assetmanager.properties

Class GlossaryProperties

java.lang.Object

org.odpi.openmetadata.accessservices.assetmanager.properties.ReferenceableProperties

org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryProperties

public class GlossaryProperties
extends ReferenceableProperties

GlossaryProperties is a class for representing a generic glossary.

Constructor Summary

Constructors

Constructor	Description
GlossaryProperties()	Default constructor
GlossaryProperties(GlossaryProperties template)	Copy/clone constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Compare the values of the supplied object with those stored in the current object.
String	getDescription()	Return the description of the glossary.
String	getDisplayName()	Return a human memorable name for the glossary.
String	getLanguage()	Return the language that the glossary contents are written in.
String	getUsage()	Return the expected usage of the glossary content.
int	hashCode()	Return hash code based on properties.
void	setDescription(String description)	Set up the description of the glossary.
void	setDisplayName(String displayName)	Set up a human memorable name for the glossary.
void	setLanguage(String language)	Set up the language that the glossary contents are written in.
void	setUsage(String usage)	Set up the expected usage of the glossary content.
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.accessservices.assetmanager.properties.ReferenceableProperties

getAdditionalProperties, getEffectiveFrom, getEffectiveTo, getExtendedProperties, getQualifiedName, getTypeName, getVendorProperties, setAdditionalProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setQualifiedName, setTypeName, setVendorProperties

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

GlossaryProperties

public GlossaryProperties()

Default constructor

GlossaryProperties

public GlossaryProperties(GlossaryProperties template)

Copy/clone constructor.

Parameters:

template - object to copy

Method Details

getDisplayName

public String getDisplayName()

Return a human memorable name for the glossary.

Returns:

string name

setDisplayName

public void setDisplayName(String displayName)

Set up a human memorable name for the glossary.

Parameters:

displayName - string name

getDescription

public String getDescription()

Return the description of the glossary.

Returns:

string text

setDescription

public void setDescription(String description)

Set up the description of the glossary.

Parameters:

description - string text

getLanguage

public String getLanguage()

Return the language that the glossary contents are written in.

Returns:

string name

setLanguage

public void setLanguage(String language)

Set up the language that the glossary contents are written in.

Parameters:

language - string name

getUsage

public String getUsage()

Return the expected usage of the glossary content.

Returns:

string description

setUsage

public void setUsage(String usage)

Set up the expected usage of the glossary content.

Parameters:

usage - string description

toString

public String toString()

Standard toString method.

Overrides:

toString in class ReferenceableProperties

Returns:

print out of variables in a JSON-style

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class ReferenceableProperties

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return hash code based on properties.

Overrides:

hashCode in class ReferenceableProperties

Returns:

int