GlossaryTerm (Subject Area OMAS Server-side 1.0 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.subjectarea.generated.entities.GlossaryTerm.GlossaryTerm

All Implemented Interfaces:

Serializable
```
public class GlossaryTerm
extends Object
implements Serializable
```
GlossaryTerm entity in the Subject Area OMAS. A semantic description of something, such as a concept, object, asset, technology, role or group.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Set<String>`	`ATTRIBUTE_NAMES_SET`
`static String[]`	`ATTRIBUTE_NAMES_SET_VALUES`
`static Set<String>`	`ENUM_NAMES_SET`
`static String[]`	`ENUM_NAMES_SET_VALUES`
`static Set<String>`	`MAP_NAMES_SET`
`static String[]`	`MAP_NAMES_SET_VALUES`
`static Set<String>`	`PROPERTY_NAMES_SET`
`static String[]`	`PROPERTY_NAMES_SET_VALUES`

Constructor Summary

Constructors
Constructor and Description

GlossaryTerm()

Constructors
Constructor and Description
`GlossaryTerm()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getAbbreviation()` {@literal How this glossary term is abbreviated.
`Map<String,String>`	`getAdditionalProperties()` {@literal Additional properties for the element.
`List<Classification>`	`getClassifications()` Classifications
`String`	`getDescription()` {@literal Full description of the glossary term.
`String`	`getDisplayName()` {@literal Consumable name for the glossary term, suitable for reports and user interfaces.
`Date`	`getEffectiveFromTime()` Return the date/time that this GlossaryTerm should start to be used (null means it can be used from creationTime).
`Date`	`getEffectiveToTime()` Return the date/time that this GlossaryTerm should no longer be used.
`String`	`getExamples()` {@literal Examples of this glossary term in use.
`Map<String,Object>`	`getExtraAttributes()` Get the extra attributes - ones that are in addition to the standard types.
`Map<String,Classification>`	`getExtraClassifications()` Extra classifications are classifications that are not in the open metadata model - we include the OMRS Classifications.
`String`	`getGlossaryName()` {@literal The name of the glossary associated with this term.
`String`	`getQualifiedName()` {@literal Unique identifier for the entity.
`String`	`getSummary()` {@literal Short description of the glossary term.
`SystemAttributes`	`getSystemAttributes()` Get the system attributes
`String`	`getUsage()` {@literal Further guidance on the use of this glossary term.
`int`	`hashCode()`
`void`	`setAbbreviation(String abbreviation)`
`void`	`setAdditionalProperties(Map<String,String> additionalProperties)`
`void`	`setClassifications(List<Classification> classifications)`
`void`	`setDescription(String description)`
`void`	`setDisplayName(String displayName)`
`void`	`setEffectiveFromTime(Date effectiveFromTime)`
`void`	`setEffectiveToTime(Date effectiveToTime)`
`void`	`setExamples(String examples)`
`void`	`setExtraAttributes(Map<String,Object> extraAttributes)`
`void`	`setExtraClassifications(Map<String,Classification> extraClassifications)`
`void`	`setGlossaryName(String glossaryName)`
`void`	`setQualifiedName(String qualifiedName)`
`void`	`setSummary(String summary)`
`void`	`setSystemAttributes(SystemAttributes systemAttributes)`
`void`	`setUsage(String usage)`
`String`	`toString()`
`StringBuilder`	`toString(StringBuilder sb)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - PROPERTY_NAMES_SET_VALUES
```
public static final String[] PROPERTY_NAMES_SET_VALUES
```
  - ATTRIBUTE_NAMES_SET_VALUES
```
public static final String[] ATTRIBUTE_NAMES_SET_VALUES
```
  - ENUM_NAMES_SET_VALUES
```
public static final String[] ENUM_NAMES_SET_VALUES
```
  - MAP_NAMES_SET_VALUES
```
public static final String[] MAP_NAMES_SET_VALUES
```
  - PROPERTY_NAMES_SET
```
public static final Set<String> PROPERTY_NAMES_SET
```
  - ATTRIBUTE_NAMES_SET
```
public static final Set<String> ATTRIBUTE_NAMES_SET
```
  - ENUM_NAMES_SET
```
public static final Set<String> ENUM_NAMES_SET
```
  - MAP_NAMES_SET
```
public static final Set<String> MAP_NAMES_SET
```
- Constructor Detail
  - GlossaryTerm
```
public GlossaryTerm()
```
- Method Detail
  - getSystemAttributes
```
public SystemAttributes getSystemAttributes()
```
    Get the system attributes
    
    Returns:
    
    SystemAttributes if populated, null otherwise.
  - setSystemAttributes
```
public void setSystemAttributes(SystemAttributes systemAttributes)
```
  - getDisplayName
```
public String getDisplayName()
```
    Consumable name for the glossary term, suitable for reports and user interfaces.
    
    Returns:
    
    String
  - setDisplayName
```
public void setDisplayName(String displayName)
```
  - getSummary
```
public String getSummary()
```
    Short description of the glossary term.
    
    Returns:
    
    String
  - setSummary
```
public void setSummary(String summary)
```
  - getDescription
```
public String getDescription()
```
    Full description of the glossary term.
    
    Returns:
    
    String
  - setDescription
```
public void setDescription(String description)
```
  - getExamples
```
public String getExamples()
```
    Examples of this glossary term in use.
    
    Returns:
    
    String
  - setExamples
```
public void setExamples(String examples)
```
  - getAbbreviation
```
public String getAbbreviation()
```
    How this glossary term is abbreviated.
    
    Returns:
    
    String
  - setAbbreviation
```
public void setAbbreviation(String abbreviation)
```
  - getUsage
```
public String getUsage()
```
    Further guidance on the use of this glossary term.
    
    Returns:
    
    String
  - setUsage
```
public void setUsage(String usage)
```
  - getGlossaryName
```
public String getGlossaryName()
```
    The name of the glossary associated with this term. This must be present.
    
    Returns:
    
    String
  - setGlossaryName
```
public void setGlossaryName(String glossaryName)
```
  - getQualifiedName
```
public String getQualifiedName()
```
    Unique identifier for the entity.
    
    Returns:
    
    String
  - setQualifiedName
```
public void setQualifiedName(String qualifiedName)
```
  - getAdditionalProperties
```
public Map<String,String> getAdditionalProperties()
```
    Additional properties for the element.
    
    Returns:
    
    {@code Map<String,String> }
  - setAdditionalProperties
```
public void setAdditionalProperties(Map<String,String> additionalProperties)
```
  - getEffectiveFromTime
```
public Date getEffectiveFromTime()
```
    Return the date/time that this GlossaryTerm should start to be used (null means it can be used from creationTime).
    
    Returns:
    
    Date the GlossaryTerm becomes effective.
  - setEffectiveFromTime
```
public void setEffectiveFromTime(Date effectiveFromTime)
```
  - getEffectiveToTime
```
public Date getEffectiveToTime()
```
    Return the date/time that this GlossaryTerm should no longer be used.
    
    Returns:
    
    Date the GlossaryTerm stops being effective.
  - setEffectiveToTime
```
public void setEffectiveToTime(Date effectiveToTime)
```
  - setExtraAttributes
```
public void setExtraAttributes(Map<String,Object> extraAttributes)
```
  - setClassifications
```
public void setClassifications(List<Classification> classifications)
```
  - getExtraAttributes
```
public Map<String,Object> getExtraAttributes()
```
    Get the extra attributes - ones that are in addition to the standard types.
    
    Returns:
    
    map of attributes, null if there are none
  - getClassifications
```
public List<Classification> getClassifications()
```
    Classifications
    
    Returns:
    
    List of Classifications, null if there are none
  - getExtraClassifications
```
public Map<String,Classification> getExtraClassifications()
```
    Extra classifications are classifications that are not in the open metadata model - we include the OMRS Classifications.
    
    Returns:
    
    Map of classifications with the classification Name as the map key
  - setExtraClassifications
```
public void setExtraClassifications(Map<String,Classification> extraClassifications)
```
  - toString
```
public StringBuilder toString(StringBuilder sb)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class GlossaryTerm

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROPERTY_NAMES_SET_VALUES

ATTRIBUTE_NAMES_SET_VALUES

ENUM_NAMES_SET_VALUES

MAP_NAMES_SET_VALUES

PROPERTY_NAMES_SET

ATTRIBUTE_NAMES_SET

ENUM_NAMES_SET

MAP_NAMES_SET

Constructor Detail

GlossaryTerm

Method Detail

getSystemAttributes

setSystemAttributes

getDisplayName

setDisplayName

getSummary

setSummary

getDescription

setDescription

getExamples

setExamples

getAbbreviation

setAbbreviation

getUsage

setUsage

getGlossaryName

setGlossaryName

getQualifiedName

setQualifiedName

getAdditionalProperties

setAdditionalProperties

getEffectiveFromTime

setEffectiveFromTime

getEffectiveToTime

setEffectiveToTime

setExtraAttributes

setClassifications

getExtraAttributes

getClassifications

getExtraClassifications

setExtraClassifications

toString

equals

hashCode

toString