org.kuali.kra.iacuc.actions

Enum IacucProtocolRequestAction

java.lang.Object

java.lang.Enum<IacucProtocolRequestAction>

org.kuali.kra.iacuc.actions.IacucProtocolRequestAction

All Implemented Interfaces:

Serializable, Comparable<IacucProtocolRequestAction>

public enum IacucProtocolRequestAction
extends Enum<IacucProtocolRequestAction>

This class is an enum which set all the properties for each request action. This is referenced by IacucProtocolActionsAction.requestAction() method

Enum Constant Summary

Enum Constants

Enum Constant and Description
REQUEST_FOR_SUSPENSION
REQUEST_TO_DEACTIVATE Request to deactivate a Protocol.
REQUEST_TO_LIFT_HOLD Request to lift a hold on a Protocol.

Method Summary

Methods

Modifier and Type	Method and Description
String	getActionName()
String	getActionTypeCode()
String	getBeanName()
String	getErrorPath()
String	getTaskName()
static IacucProtocolRequestAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static IacucProtocolRequestAction	valueOfActionTypeCode(String actionTypeCode) Returns the value of this enumeration based on the given actionTypeCode.
static IacucProtocolRequestAction	valueOfTaskName(String taskName) Returns the value of this enumeration based on the given taskName.
static IacucProtocolRequestAction[]	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

REQUEST_TO_DEACTIVATE

public static final IacucProtocolRequestAction REQUEST_TO_DEACTIVATE

Request to deactivate a Protocol.

REQUEST_TO_LIFT_HOLD

public static final IacucProtocolRequestAction REQUEST_TO_LIFT_HOLD

Request to lift a hold on a Protocol.

REQUEST_FOR_SUSPENSION

public static final IacucProtocolRequestAction REQUEST_FOR_SUSPENSION

Method Detail

values

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

Returns:

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

valueOf

public static IacucProtocolRequestAction 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

getActionTypeCode

public String getActionTypeCode()

getTaskName

public String getTaskName()

getErrorPath

public String getErrorPath()

getBeanName

public String getBeanName()

getActionName

public String getActionName()

valueOfTaskName

public static IacucProtocolRequestAction valueOfTaskName(String taskName)

Returns the value of this enumeration based on the given taskName. This can return null, which isn't ideal but is necessary since TaskName is not an enum.

Parameters:

taskName - the name of the task to perform

Returns:

the ProtocolRequestAction corresponding to the taskName

valueOfActionTypeCode

public static IacucProtocolRequestAction valueOfActionTypeCode(String actionTypeCode)

Returns the value of this enumeration based on the given actionTypeCode. This can return null, which isn't ideal but is necessary since ProtocolActionTypeCode is not an enum.

Parameters:

actionTypeCode - the action type code

Returns:

the ProtocolRequestAction corresponding to the actionTypeCode