ilog.views.gantt.event

Class ResourceQuantityEvent

java.lang.Object

java.util.EventObject

ilog.views.gantt.util.event.IlvPropertyEvent

ilog.views.gantt.event.ResourcePropertyEvent

ilog.views.gantt.event.ResourceQuantityEvent

All Implemented Interfaces:

ResourceEvent, Serializable

public class ResourceQuantityEvent
extends ResourcePropertyEvent

ResourceQuantityEvent is fired by an IlvResource both before and after its quantity is modified. Immediately before its quantity is modified, an IlvResource fires an aboutToChange ResourceQuantityEvent in all listeners registered with the Gantt data model. Listeners can modify or constrain the proposed quantity by invoking setNewQuantity(). Alternatively, a listener can veto the proposed change by invoking veto().

After its quantity is modified, an IlvResource will fire a changed ResourceQuantityEvent in all listeners registered with the Gantt data model. Listeners can access the old and new values of the resource's quantity, but cannot modify them via the event mechanism.

See Also:

IlvResource, IlvGanttModel.addResourceListener(ilog.views.gantt.event.ResourceListener), Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ResourceQuantityEvent(IlvResource resource, float oldQuantity, float newQuantity, boolean aboutToChangeEvent) Constructs a new ResourceQuantityEvent generated by the specified resource and with the specified old and new quantity values.

Method Summary

Modifier and Type	Method and Description
float	getNewQuantity() Returns the resource's new quantity.
float	getOldQuantity() Returns the resource's old quantity.
void	setNewQuantity(float quantity) Sets the resource's proposed new quantity.

Methods inherited from class ilog.views.gantt.event.ResourcePropertyEvent

getResource

Methods inherited from class ilog.views.gantt.util.event.IlvPropertyEvent

getNewValue, getOldValue, isAboutToChangeEvent, isChangedEvent, isVetoed, setNewValue, veto

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ResourceQuantityEvent

public ResourceQuantityEvent(IlvResource resource,
                             float oldQuantity,
                             float newQuantity,
                             boolean aboutToChangeEvent)

Constructs a new ResourceQuantityEvent generated by the specified resource and with the specified old and new quantity values.

Parameters:

resource - the resource where the event originated

oldQuantity - the resource's previous quantity

newQuantity - the resource's new quantity

aboutToChangeEvent - true if this is a resourceQuantityAboutToChange event or false if this is a resourceQuantityChanged event.

Method Detail

getOldQuantity

public float getOldQuantity()

Returns the resource's old quantity. If this is a resourceQuantityAboutToChange event, then this will be the same as the resource's current quantity since the change has not actually occurred yet. If this is a resourceQuantityChanged event, this will be the resource's quantity prior to the current modification being reported.

Returns:

The old quantity.

getNewQuantity

public float getNewQuantity()

Returns the resource's new quantity. If this is a resourceQuantityAboutToChange event, then this is will be the resource's proposed value. If this is a resourceQuantityChanged event, this will be the resource's new quantity which is being reported.

Returns:

The new quantity.

setNewQuantity

public void setNewQuantity(float quantity)

Sets the resource's proposed new quantity. This method only has meaning if this is a resourceQuantityAboutToChange event. By using this method, a listener can constrain changes to the resource's quantity.

Parameters:

quantity - The new quantity.