Package org.odpi.openmetadata.adapters.connectors.surveyaction.controls

Enum Class FolderRequestParameter

java.lang.Object

java.lang.Enum<FolderRequestParameter>

org.odpi.openmetadata.adapters.connectors.surveyaction.controls.FolderRequestParameter

All Implemented Interfaces:

Serializable, Comparable<FolderRequestParameter>, Constable

public enum FolderRequestParameter
extends Enum<FolderRequestParameter>

FolderRequestParameter details the request parameter supported by the Folder Surveyor.

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
ANALYSIS_LEVEL

Field Summary

Fields

Modifier and Type	Field	Description
final String	dataType
final String	description
final String	example
final String	name

Method Summary

Modifier and Type	Method	Description
String	getDataType()	Return the data type for the request parameter.
String	getDescription()	Return the description of the request parameter.
String	getExample()	Return an example of the request parameter to help users understand how to set it up.
String	getName()	Return the name of the request parameter.
RequestParameterType	getRequestParameterType()	Return a summary of this enum to use in a service provider.
static List<RequestParameterType>	getRequestParameterTypes()	Retrieve all the defined request parameters
String	toString()	Output of this enum class and main value.
static FolderRequestParameter	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FolderRequestParameter[]	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

ANALYSIS_LEVEL

public static final FolderRequestParameter ANALYSIS_LEVEL

Field Details

name

public final String name

description

public final String description

dataType

public final String dataType

example

public final String example

Method Details

values

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

getName

public String getName()

Return the name of the request parameter.

Returns:

string name

getDescription

public String getDescription()

Return the description of the request parameter.

Returns:

text

getDataType

public String getDataType()

Return the data type for the request parameter.

Returns:

data type name

getExample

public String getExample()

Return an example of the request parameter to help users understand how to set it up.

Returns:

example

getRequestParameterTypes

public static List<RequestParameterType> getRequestParameterTypes()

Retrieve all the defined request parameters

Returns:

list of request parameter types

getRequestParameterType

public RequestParameterType getRequestParameterType()

Return a summary of this enum to use in a service provider.

Returns:

request parameter type

toString

public String toString()

Output of this enum class and main value.

Overrides:

toString in class Enum<FolderRequestParameter>

Returns:

string showing enum value