ilog.views.gantt.event

Class ReservationRemovedEvent

java.lang.Object

java.util.EventObject

ilog.views.gantt.event.ReservationRemovedEvent

All Implemented Interfaces:

ReservationEvent, Serializable

public class ReservationRemovedEvent
extends EventObject
implements ReservationEvent

ReservationRemovedEvent is used to notify ReservationListeners when a reservation has been removed from an IlvGanttModel.

See Also:

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	REMOVING_ACTIVITY Indicates that the reservation was removed as a side effect of an activity removal.
static int	REMOVING_NONE Indicates that the reservation was not removed as a side effect of an activity or resource removal.
static int	REMOVING_RESOURCE Indicates that the reservation was removed as a side effect of a resource removal.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ReservationRemovedEvent(IlvGanttModel model, IlvReservation reservation) Constructs a new ReservationRemovedEvent generated by the specified data model that can be used to notify listeners when a reservation has been removed from a Gantt data model.
ReservationRemovedEvent(IlvGanttModel model, IlvReservation reservation, int removingEntity) Constructs a new ReservationRemovedEvent generated by the specified data model that can be used to notify listeners when a reservation has been removed from a Gantt data model.

Method Summary

Modifier and Type	Method and Description
IlvGanttModel	getGanttModel() Returns the data model where the event originated.
IlvReservation	getReservation() Returns the reservation that was removed.
boolean	isRemovingActivity() Returns whether the reservation was removed as the side effect of removing an activity from the data model.
boolean	isRemovingResource() Returns whether the reservation was removed as the side effect of removing a resource from the data model.

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

Field Detail

REMOVING_NONE

public static final int REMOVING_NONE

Indicates that the reservation was not removed as a side effect of an activity or resource removal.

Since:

JViews 5.0

See Also:

Constant Field Values

REMOVING_ACTIVITY

public static final int REMOVING_ACTIVITY

Indicates that the reservation was removed as a side effect of an activity removal.

Since:

JViews 5.0

See Also:

Constant Field Values

REMOVING_RESOURCE

public static final int REMOVING_RESOURCE

Indicates that the reservation was removed as a side effect of a resource removal.

Since:

JViews 5.0

See Also:

Constant Field Values

Constructor Detail

ReservationRemovedEvent

public ReservationRemovedEvent(IlvGanttModel model,
                               IlvReservation reservation,
                               int removingEntity)

Constructs a new ReservationRemovedEvent generated by the specified data model that can be used to notify listeners when a reservation has been removed from a Gantt data model.

Parameters:

model - The data model where the event originated.

reservation - The reservation that was removed from model.

removingEntity - Indicates whether the reservation was removed as the side effect of removing an activity or resource from the data model. The value should be set to REMOVING_ACTIVITY when reservations are removed by the IlvGanttModel.setRootActivity(ilog.views.gantt.IlvActivity), IlvGanttModel.removeActivity(ilog.views.gantt.IlvActivity), or IlvGanttModel.removeActivity(ilog.views.gantt.IlvActivity,int) methods. The value should be REMOVING_RESOURCE when reservations are removed by the IlvGanttModel.setRootResource(ilog.views.gantt.IlvResource), IlvGanttModel.removeResource(ilog.views.gantt.IlvResource), or IlvGanttModel.removeResource(ilog.views.gantt.IlvResource,int) methods. The value should be REMOVING_NONE at all other times.

Since:

JViews 5.0

ReservationRemovedEvent

public ReservationRemovedEvent(IlvGanttModel model,
                               IlvReservation reservation)

Constructs a new ReservationRemovedEvent generated by the specified data model that can be used to notify listeners when a reservation has been removed from a Gantt data model. The event indicates that the reservation was not removed as a side effect of an activity or resource removal.

Parameters:

model - The data model where the event originated.

reservation - The reservation that was removed from model.

Method Detail

getGanttModel

public IlvGanttModel getGanttModel()

Returns the data model where the event originated.

Returns:

The IlvGanttModel where this event originated.

getReservation

public IlvReservation getReservation()

Returns the reservation that was removed.

Specified by:

getReservation in interface ReservationEvent

Returns:

The IlvReservation which was removed.

isRemovingActivity

public boolean isRemovingActivity()

Returns whether the reservation was removed as the side effect of removing an activity from the data model. The value will be true if the reservation was removed by the IlvGanttModel.setRootActivity(ilog.views.gantt.IlvActivity), IlvGanttModel.removeActivity(ilog.views.gantt.IlvActivity), or IlvGanttModel.removeActivity(ilog.views.gantt.IlvActivity,int) methods. The value will be false at all other times.

Returns:

Whether the reservation was removed as the side effect of removing an activity from the data model.

Since:

JViews 5.0

isRemovingResource

public boolean isRemovingResource()

Returns whether the reservation was removed as the side effect of removing a resource from the data model. The value will be true if the reservation was removed by the IlvGanttModel.setRootResource(ilog.views.gantt.IlvResource), IlvGanttModel.removeResource(ilog.views.gantt.IlvResource), or IlvGanttModel.removeResource(ilog.views.gantt.IlvResource,int) methods. The value will be false at all other times.

Returns:

Whether the reservation was removed as the side effect of removing a resource from the data model.

Since:

JViews 5.0