Package org.odpi.openmetadata.frameworks.openmetadata.enums

Interface OpenMetadataEnum

All Known Implementing Classes:

ByteOrdering, CollectionMemberStatus, CommentType, ConfidenceLevel, ConfidentialityLevel, ContactMethodType, CriticalityLevel, DataClassAssignmentStatus, DataItemSortOrder, EngineActionStatus, GlossaryTermActivityType, GlossaryTermAssignmentStatus, GlossaryTermRelationshipStatus, GovernanceClassificationStatus, ImpactSeverity, IncidentReportStatus, KeyPattern, OrderBy, RetentionBasis, StarRating, ToDoStatus

public interface OpenMetadataEnum

OpenMetadataEnum defines the common methods for an open metadata enum type.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description of the enumeration.
String	getDescriptionGUID()	Return the unique identifier for the valid value that represents the enum value.
String	getName()	Return the default name of the enumeration.
int	getOrdinal()	Return the numeric representation of the enumeration.
boolean	isDefault()	Return whether the enum is the default value or not.

Method Details

getOrdinal

int getOrdinal()

Return the numeric representation of the enumeration.

Returns:

int ordinal

getName

String getName()

Return the default name of the enumeration.

Returns:

String name

getDescription

String getDescription()

Return the default description of the enumeration.

Returns:

String description

getDescriptionGUID

String getDescriptionGUID()

Return the unique identifier for the valid value that represents the enum value.

Returns:

guid

isDefault

boolean isDefault()

Return whether the enum is the default value or not.

Returns:

boolean