ilog.views.gantt.model.general

Class IlvGeneralReservation

java.lang.Object

ilog.views.gantt.model.IlvAbstractReservation

ilog.views.gantt.model.IlvSimpleReservation

ilog.views.gantt.model.general.IlvGeneralReservation

All Implemented Interfaces:

IlvReservation, IlvUserPropertyHolder, Serializable

public class IlvGeneralReservation
extends IlvSimpleReservation
implements IlvUserPropertyHolder

IlvGeneralReservation is an extension of IlvSimpleReservation that adds support for user-defined properties. IlvGeneralReservation fires an ReservationUserPropertyEvent both before and after a user-defined property is modified. Immediately before a property is modified, IlvGeneralReservation fires an aboutToChange ReservationUserPropertyEvent to all listeners registered with the Gantt data model. This gives the listeners an opportunity to constrain or veto the proposed property change. If the property change is not vetoed, then the change is applied and IlvGeneralReservation fires a changed ReservationUserPropertyEvent to all listeners registered with the Gantt data model.

IlvGeneralReservation predefines 3 properties that are inherited from its IlvSimpleReservation superclass. These predefined properties can be accessed through the getProperty(java.lang.String) and setProperty(java.lang.String, java.lang.Object) methods in the same manner as user-defined properties. However, the predefined properties fire specific event types. They do not fire ReservationUserPropertyEvents as described above for user-defined properties. The predefined events are shown in the following table:

Property	Value Type	Equivalent getXXX Method	Equivalent setXXX Method	Event Type
activity	IlvActivity	getActivity	n/a	n/a
resource	IlvResource	getResource	setResource	ReservedResourceEvent

Since:

JViews 5.5

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvGeneralReservation.Factory IlvGeneralReservation.Factory is a factory that creates instances of IlvGeneralReservation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVITY_PROPERTY Identifies the reservation's activity property.
static String	RESOURCE_PROPERTY Identifies the reservation's resource property.

Constructor Summary

Constructors

Constructor and Description
IlvGeneralReservation(IlvResource resource, IlvActivity activity) Creates a new IlvGeneralReservation that assigns the specified resource to the specified activity.

Method Summary

Modifier and Type	Method and Description
Object	getProperty(String property) Returns the value of a user-defined property or null if the property does not exist.
Collection<String>	getPropertyNames() Returns a collection that contains the names of all the properties of this reservation.
boolean	isUserProperty(String name) Returns true if the property is a user-defined property.
protected String	paramString() Returns a parameter string that represents the state of this reservation.
Iterator<String>	propertyNameIterator() Returns an iterator over all the property names of this reservation.
Object	setProperty(String property, Object value) Stores a user-defined property in this reservation's property table.

Methods inherited from class ilog.views.gantt.model.IlvSimpleReservation

getActivity, getResource, setResource

Methods inherited from class ilog.views.gantt.model.IlvAbstractReservation

fireEvent, fireReservedResourceAboutToChange, fireReservedResourceChanged, getGanttModel, setGanttModelImpl, toString

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVITY_PROPERTY

public static final String ACTIVITY_PROPERTY

Identifies the reservation's activity property. The value is "activity".

See Also:

Constant Field Values

RESOURCE_PROPERTY

public static final String RESOURCE_PROPERTY

Identifies the reservation's resource property. The value is "resource".

See Also:

Constant Field Values

Constructor Detail

IlvGeneralReservation

public IlvGeneralReservation(IlvResource resource,
                             IlvActivity activity)

Creates a new IlvGeneralReservation that assigns the specified resource to the specified activity.

Parameters:

resource - The resource that is assigned.

activity - The activity that the resource is assigned to.

Method Detail

getProperty

public Object getProperty(String property)

Returns the value of a user-defined property or null if the property does not exist.

Specified by:

getProperty in interface IlvUserPropertyHolder

Parameters:

property - The name of the property.

Returns:

The value of the property or null if the property does not exist.

See Also:

setProperty(java.lang.String, java.lang.Object), getPropertyNames()

setProperty

public Object setProperty(String property,
                          Object value)

Stores a user-defined property in this reservation's property table.

Specified by:

setProperty in interface IlvUserPropertyHolder

Parameters:

property - The name of the property.

value - The value of the property. If the value is null the property is removed.

Returns:

The value of the property set, or the old value of the property if the value is being removed.

See Also:

getProperty(java.lang.String), getPropertyNames()

propertyNameIterator

public Iterator<String> propertyNameIterator()

Returns an iterator over all the property names of this reservation.

Specified by:

propertyNameIterator in interface IlvUserPropertyHolder

Returns:

The iterator.

Since:

JViews 6.0

getPropertyNames

public Collection<String> getPropertyNames()

Returns a collection that contains the names of all the properties of this reservation.

isUserProperty

public boolean isUserProperty(String name)

Returns true if the property is a user-defined property.

Specified by:

isUserProperty in interface IlvUserPropertyHolder

Parameters:

name - The name of the property.

Returns:

Returns true if the property is a user-defined property, false otherwise.

paramString

protected String paramString()

Returns a parameter string that represents the state of this reservation.

Overrides:

paramString in class IlvAbstractReservation

Returns:

A string representing the status of the reservation.