org.flexiblepower.ral.messages

Enum AllocationStatus

java.lang.Object

java.lang.Enum<AllocationStatus>

org.flexiblepower.ral.messages.AllocationStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AllocationStatus>

public enum AllocationStatus
extends java.lang.Enum<AllocationStatus>

This enumeration contains all possible states that may be fed back by an appliance driver to an energy app in response to an Allocation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCEPTED The appliance driver has accepted the Allocation, meaning that it will try to follow the instructions from the Allocation message as closely as possible.
FINISHED When the Allocation has been completed, the appliance driver will inform the energy app by sending a finished event.
PROCESSING The driver has not yet started but is processing the instructions in order to be able to start on time.
REJECTED The driver is not able or willing to follow up the instructions.
STARTED The driver has started the Allocation of the energy app.

Method Summary

Methods

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

ACCEPTED

public static final AllocationStatus ACCEPTED

The appliance driver has accepted the Allocation, meaning that it will try to follow the instructions from the Allocation message as closely as possible.

REJECTED

public static final AllocationStatus REJECTED

The driver is not able or willing to follow up the instructions.

PROCESSING

public static final AllocationStatus PROCESSING

The driver has not yet started but is processing the instructions in order to be able to start on time. Once the PROCESSING state has begun it is not possible anymore for the energy app to send a new Allocation message to overrule a previous one. This PROCESSING state corresponds with the allocationDelay attribute of the ControlSpaceUpdate message. This state is optional. It is allowed to go from the Accepted state directly to the Started state, if no processing time is needed.

STARTED

public static final AllocationStatus STARTED

The driver has started the Allocation of the energy app.

FINISHED

public static final AllocationStatus FINISHED

When the Allocation has been completed, the appliance driver will inform the energy app by sending a finished event.

Method Detail

values

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

Returns:

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

valueOf

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