ilog.views.gantt.event

Class ReservedResourceEvent

java.lang.Object

java.util.EventObject

ilog.views.gantt.util.event.IlvPropertyEvent

ilog.views.gantt.event.ReservationPropertyEvent

ilog.views.gantt.event.ReservedResourceEvent

All Implemented Interfaces:

ReservationEvent, Serializable

public class ReservedResourceEvent
extends ReservationPropertyEvent

ReservedResourceEvent is fired by an IlvReservation both before and after the activity's reserved resource is modified. Immediately before the resource is modified, an IlvReservation fires an aboutToChange ReservedResourceEvent in all listeners registered with the Gantt data model. Listeners can modify or constrain the proposed resource by invoking setNewResource(). Alternatively, a listener can veto the proposed change by invoking veto().

After the activity's reserved resource is modified, an IlvReservation will fire a changed ReservedResourceEvent in all listeners registered with the Gantt data model. Listeners can access the old and new resources, but cannot modify them via the event mechanism.

See Also:

IlvReservation, IlvGanttModel.addReservationListener(ilog.views.gantt.event.ReservationListener), Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ReservedResourceEvent(IlvReservation reservation, IlvResource oldResource, IlvResource newResource, boolean aboutToChangeEvent) Constructs a new ReservedResourceEvent generated by the specified reservation and with the specified old and new resources.

Method Summary

Modifier and Type	Method and Description
IlvResource	getNewResource() Returns the activity's newly reserved resource.
IlvResource	getOldResource() Returns the activity's previously reserved resource.
void	setNewResource(IlvResource resource) Sets the activity's proposed new reservation.

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

getReservation

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

ReservedResourceEvent

public ReservedResourceEvent(IlvReservation reservation,
                             IlvResource oldResource,
                             IlvResource newResource,
                             boolean aboutToChangeEvent)

Constructs a new ReservedResourceEvent generated by the specified reservation and with the specified old and new resources.

Parameters:

reservation - the reservation where the event originated

oldResource - the activity's previously reserved resource

newResource - the activity's newly reserved resource

aboutToChangeEvent - true if this is an aboutToChange event or false if this is a changed event.

Method Detail

getOldResource

public IlvResource getOldResource()

Returns the activity's previously reserved resource. If this is an aboutToChange event, then this will be the same as the current resource since the change has not actually occurred yet. If this is a changed event, this will be the reserved resource prior to the current modification being reported.

Returns:

The old IlvResource.

getNewResource

public IlvResource getNewResource()

Returns the activity's newly reserved resource. If this is an aboutToChange event, then this is will be the proposed resource. If this is a changed event, this will be the activity's newly reserved resource which is being reported.

Returns:

The new IlvResource.

setNewResource

public void setNewResource(IlvResource resource)

Sets the activity's proposed new reservation. This method only has meaning if this is an aboutToChange event. By using this method, a listener can constrain changes to the activity's reserved resource.

Parameters:

resource - the reserved resource