Package org.odpi.openmetadata.samples.archiveutilities.sustainability

Enum Class SustainabilitySubjectAreaDefinition

java.lang.Object

java.lang.Enum<SustainabilitySubjectAreaDefinition>

org.odpi.openmetadata.samples.archiveutilities.sustainability.SustainabilitySubjectAreaDefinition

All Implemented Interfaces:

Serializable, Comparable<SustainabilitySubjectAreaDefinition>, Constable

public enum SustainabilitySubjectAreaDefinition
extends Enum<SustainabilitySubjectAreaDefinition>

The CocoSubjectAreaDefinition is used to feed the definition of the subject areas for Coco Pharmaceuticals.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
SUSTAINABILITY

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns a detailed description of the assets within the zone.
String	getDisplayName()	Returns a descriptive name of the zone.
int	getDomain()	Return the identifier of the domain that this subject area belongs - 0 means all domains
SustainabilitySubjectAreaDefinition	getParent()	Return the name of the parent subject area - null for top level.
String	getQualifiedName()	Returns the unique name for the subject area entity.
String	getScope()	Returns a description of the organizational scope for the use of this subject area.
String	getSubjectAreaName()	Returns the unique name for the zone.
String	getUsage()	Get the typical usage of the subject area
String	toString()	String containing the definition values
static SustainabilitySubjectAreaDefinition	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SustainabilitySubjectAreaDefinition[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUSTAINABILITY

public static final SustainabilitySubjectAreaDefinition SUSTAINABILITY

Method Details

values

public static SustainabilitySubjectAreaDefinition[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SustainabilitySubjectAreaDefinition valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getQualifiedName

public String getQualifiedName()

Returns the unique name for the subject area entity.

Returns:

qualified name

getSubjectAreaName

public String getSubjectAreaName()

Returns the unique name for the zone.

Returns:

unique name

getParent

public SustainabilitySubjectAreaDefinition getParent()

Return the name of the parent subject area - null for top level.

Returns:

subject area name.

getDisplayName

public String getDisplayName()

Returns a descriptive name of the zone.

Returns:

display name

getDescription

public String getDescription()

Returns a detailed description of the assets within the zone.

Returns:

description

getScope

public String getScope()

Returns a description of the organizational scope for the use of this subject area.

Returns:

scope

getUsage

public String getUsage()

Get the typical usage of the subject area

Returns:

usage

getDomain

public int getDomain()

Return the identifier of the domain that this subject area belongs - 0 means all domains

Returns:

domain identifier

toString

public String toString()

String containing the definition values

Overrides:

toString in class Enum<SustainabilitySubjectAreaDefinition>

Returns:

printable string