Package org.odpi.openmetadata.accessservices.datamanager.properties

Enum APIParameterListType

java.lang.Object

java.lang.Enum<APIParameterListType>

org.odpi.openmetadata.accessservices.datamanager.properties.APIParameterListType

All Implemented Interfaces:

Serializable, Comparable<APIParameterListType>

public enum APIParameterListType
extends Enum<APIParameterListType>
implements Serializable

An APIParameterListType defines which parameter list relationship to use when attaching an APIParameterList to an operation.

Enum Constant Summary

Enum Constants

Enum Constant	Description
HEADER
REQUEST
RESPONSE

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description for the key pattern for this enum instance.
String	getName()	Return the default name for this enum instance.
String	getOpenTypeRelationshipName()	Return the Open Metadata Type Name used on the relationship that links the APIParameterList to an APIOperation.
int	getOrdinal()	Return the code for this enum instance
String	toString()	Standard toString method.
static APIParameterListType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static APIParameterListType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HEADER

public static final APIParameterListType HEADER

REQUEST

public static final APIParameterListType REQUEST

RESPONSE

public static final APIParameterListType RESPONSE

Method Detail

values

public static APIParameterListType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (APIParameterListType c : APIParameterListType.values())
    System.out.println(c);

Returns:

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

valueOf

public static APIParameterListType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getOrdinal

public int getOrdinal()

Return the code for this enum instance

Returns:

int key pattern code

getName

public String getName()

Return the default name for this enum instance.

Returns:

String default name

getDescription

public String getDescription()

Return the default description for the key pattern for this enum instance.

Returns:

String default description

getOpenTypeRelationshipName

public String getOpenTypeRelationshipName()

Return the Open Metadata Type Name used on the relationship that links the APIParameterList to an APIOperation.

Returns:

strinng type name

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<APIParameterListType>

Returns:

print out of variables in a JSON-style