Package org.odpi.openmetadata.accessservices.dataengine.model

Enum Class OwnerType

java.lang.Object

java.lang.Enum<OwnerType>

org.odpi.openmetadata.accessservices.dataengine.model.OwnerType

All Implemented Interfaces:

Serializable, Comparable<OwnerType>, Constable

public enum OwnerType
extends Enum<OwnerType>
implements Serializable

OwnerType defines the identifier used in an Asset's owner property.

• User Identifier - The owner's user id is stored in the owner property.
• Profile - The owner's profile unique identifier (guid) is stored in the owner property.
• Other - A different identifier for the owner outside of the scope of open metadata has been used.

Being able to use a profile guid in this field allows for Assets to be owned by Teams and Engines as well as people.

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
OTHER	A different identifier for the owner outside of the scope of open metadata has been used.
PROFILE_ID	The owner's profile unique identifier (guid) is stored in the owner property.
USER_ID	The owner's user id is stored in the owner property.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description of the enumeration.
String	getName()	Return the default name of the enumeration.
String	getOpenTypeGUID()	Return the unique identifier for the open metadata enum type that this enum class represents.
String	getOpenTypeName()	Return the unique name for the open metadata enum type that this enum class represents.
int	getOpenTypeOrdinal()	Return the code for this enum that comes from the Open Metadata Type that this enum represents.
int	getOrdinal()	Return the numeric representation of the enumeration.
String	toString()
static OwnerType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OwnerType[]	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

USER_ID

public static final OwnerType USER_ID

The owner's user id is stored in the owner property.

PROFILE_ID

public static final OwnerType PROFILE_ID

The owner's profile unique identifier (guid) is stored in the owner property.

OTHER

public static final OwnerType OTHER

A different identifier for the owner outside of the scope of open metadata has been used.

Method Details

values

public static OwnerType[] 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 OwnerType 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

getOpenTypeGUID

public String getOpenTypeGUID()

Return the unique identifier for the open metadata enum type that this enum class represents.

Returns:

string guid

getOpenTypeName

public String getOpenTypeName()

Return the unique name for the open metadata enum type that this enum class represents.

Returns:

string name

getOpenTypeOrdinal

public int getOpenTypeOrdinal()

Return the code for this enum that comes from the Open Metadata Type that this enum represents.

Returns:

openTypeOrdinal int code number

getOrdinal

public int getOrdinal()

Return the numeric representation of the enumeration.

Returns:

int ordinal

getName

public String getName()

Return the default name of the enumeration.

Returns:

String name

getDescription

public String getDescription()

Return the default description of the enumeration.

Returns:

String description

toString

public String toString()

Overrides:

toString in class Enum<OwnerType>