org.flexiblepower.ral.messages

Class AllocationStatusUpdate

java.lang.Object

org.flexiblepower.ral.messages.ResourceMessage

org.flexiblepower.ral.messages.AllocationStatusUpdate

public final class AllocationStatusUpdate
extends ResourceMessage

After an appliance driver received an Allocation message, it is good practice to provide feedback to the energy application on the follow up actions. This can be done via this message. All ControlSpace categories use this AllocationStatusUpdate message; there are no specific derivations in use.

Constructor Summary

Constructors

Constructor and Description
AllocationStatusUpdate(java.util.Date timestamp, Allocation allocation, AllocationStatus status, java.lang.String additionalInfo)
AllocationStatusUpdate(java.lang.String resourceId, java.util.Date timestamp, java.util.UUID allocationId, AllocationStatus status, java.lang.String additionalInfo)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAdditionalInfo()
java.util.UUID	getAllocationId()
AllocationStatus	getStatus()
int	hashCode()
protected void	toString(java.lang.StringBuilder sb)

Methods inherited from class org.flexiblepower.ral.messages.ResourceMessage

getResourceId, getResourceMessageId, getTimestamp, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AllocationStatusUpdate

public AllocationStatusUpdate(java.util.Date timestamp,
                      Allocation allocation,
                      AllocationStatus status,
                      java.lang.String additionalInfo)

Parameters:

timestamp - The moment when this constructor is called

allocation - the Allocation to which this update is the response

status - This attribute indicates the current status of the Allocation. It assumes one of the values specified in the AllocationStatus enumeration.

additionalInfo - In addition to the status attribute additional and more specific information can be expressed in a human readable format.

AllocationStatusUpdate

public AllocationStatusUpdate(java.lang.String resourceId,
                      java.util.Date timestamp,
                      java.util.UUID allocationId,
                      AllocationStatus status,
                      java.lang.String additionalInfo)

Parameters:

resourceId - The resource identifier

timestamp - The moment when this constructor is called

allocationId - An identifier that uniquely identifies the Allocation message that this update refers to (the ResourceMessage.getResourceMessageId()).

status - This attribute indicates the current status of the Allocation. It assumes one of the values specified in the AllocationStatus enumeration.

additionalInfo - In addition to the status attribute additional and more specific information can be expressed in a human readable format.

Method Detail

getAllocationId

public java.util.UUID getAllocationId()

Returns:

An identifier that uniquely identifies the Allocation message that this update refers to (the ResourceMessage.getResourceMessageId()).

getStatus

public AllocationStatus getStatus()

Returns:

This attribute indicates the current status of the Allocation. It assumes one of the values specified in the AllocationStatus enumeration.

getAdditionalInfo

public java.lang.String getAdditionalInfo()

Returns:

In addition to the status attribute additional and more specific information can be expressed in a human readable format.

hashCode

public int hashCode()

Overrides:

hashCode in class ResourceMessage

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class ResourceMessage

toString

protected void toString(java.lang.StringBuilder sb)

Overrides:

toString in class ResourceMessage