org.labkey.remoteapi

Enum Command.CommonParameters

java.lang.Object

java.lang.Enum<Command.CommonParameters>

org.labkey.remoteapi.Command.CommonParameters

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Command.CommonParameters>

Enclosing class:

Command<ResponseType extends CommandResponse>

public static enum Command.CommonParameters
extends java.lang.Enum<Command.CommonParameters>

An enum of common parameter names used in API URLs.

Enum Constant Summary

Enum Constants

Enum Constant and Description
apiVersion

Method Summary

Methods

Modifier and Type	Method and Description
static Command.CommonParameters	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Command.CommonParameters[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

apiVersion

public static final Command.CommonParameters apiVersion

Method Detail

values

public static Command.CommonParameters[] 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 (Command.CommonParameters c : Command.CommonParameters.values())
    System.out.println(c);

Returns:

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

valueOf

public static Command.CommonParameters valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null