Package org.odpi.openmetadata.samples.archiveutilities.governanceengines

Enum Class CocoRequestTypeDefinition

java.lang.Object

java.lang.Enum<CocoRequestTypeDefinition>

org.odpi.openmetadata.samples.archiveutilities.governanceengines.CocoRequestTypeDefinition

All Implemented Interfaces:

Serializable, Comparable<CocoRequestTypeDefinition>, Constable

public enum CocoRequestTypeDefinition
extends Enum<CocoRequestTypeDefinition>

Defines the request types for the governance engines that identify which governance service to call for a specific request type.

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
CERTIFY_HOSPITAL	certify-hospital
CHECK_DATA	check-weekly-measurements-data-quality
NOMINATE_HOSPITAL	nominate-hospital
ONBOARD_HOSPITAL	onboard-hospital
SET_UP_CLINICAL_TRIAL	set-up-clinical-trial
SET_UP_DATA_LAKE	set-up-data-lake

Method Summary

Modifier and Type	Method	Description
List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget>	getActionTargets()	Return predefined action targets used by this service.
String	getGovernanceActionTypeGUID()	Return the unique identifier of the governance action type.
CocoGovernanceEngineDefinition	getGovernanceEngine()	Return the governance engine where this request type belongs to.
String	getGovernanceRequestType()	Return the Request Type.
CocoGovernanceServiceDefinition	getGovernanceService()	Return the governance service that this request type maps to,
Map<String,String>	getRequestParameters()	Return the request parameters (if needed).
String	getServiceRequestType()	Return the service request type to map to.
String	getSupportedElementQualifiedName()	Return the element that is supported by this request.
String	toString()	Output of this enum class and main value.
static CocoRequestTypeDefinition	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CocoRequestTypeDefinition[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SET_UP_DATA_LAKE

public static final CocoRequestTypeDefinition SET_UP_DATA_LAKE

set-up-data-lake

NOMINATE_HOSPITAL

public static final CocoRequestTypeDefinition NOMINATE_HOSPITAL

nominate-hospital

CERTIFY_HOSPITAL

public static final CocoRequestTypeDefinition CERTIFY_HOSPITAL

certify-hospital

ONBOARD_HOSPITAL

public static final CocoRequestTypeDefinition ONBOARD_HOSPITAL

onboard-hospital

CHECK_DATA

public static final CocoRequestTypeDefinition CHECK_DATA

check-weekly-measurements-data-quality

SET_UP_CLINICAL_TRIAL

public static final CocoRequestTypeDefinition SET_UP_CLINICAL_TRIAL

set-up-clinical-trial

Method Details

values

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

getGovernanceRequestType

public String getGovernanceRequestType()

Return the Request Type.

Returns:

string

getServiceRequestType

public String getServiceRequestType()

Return the service request type to map to.

Returns:

string

getRequestParameters

public Map<String,String> getRequestParameters()

Return the request parameters (if needed).

Returns:

map or null

getActionTargets

public List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget> getActionTargets()

Return predefined action targets used by this service. They are attached to the governance action type.

Returns:

list

getGovernanceEngine

public CocoGovernanceEngineDefinition getGovernanceEngine()

Return the governance engine where this request type belongs to.

Returns:

governance engine definition enum

getGovernanceService

public CocoGovernanceServiceDefinition getGovernanceService()

Return the governance service that this request type maps to,

Returns:

governance service definition enum

getGovernanceActionTypeGUID

public String getGovernanceActionTypeGUID()

Return the unique identifier of the governance action type.

Returns:

string

getSupportedElementQualifiedName

public String getSupportedElementQualifiedName()

Return the element that is supported by this request.

Returns:

qualified name string

toString

public String toString()

Output of this enum class and main value.

Overrides:

toString in class Enum<CocoRequestTypeDefinition>

Returns:

string showing enum value