ilog.cpl.equipment
Interface IlpEquipmentModel

All Superinterfaces:
IlpGraphModel
All Known Subinterfaces:
IlpMutableEquipmentModel
All Known Implementing Classes:
IlpAbstractEquipmentModel, IlpDefaultEquipmentModel

public interface IlpEquipmentModel
extends IlpGraphModel

The IlpEquipmentModel interface describes the equipment component object hierarchy and its associations.

The model contains a set of top-level objects (accessible through getRootObjects) and child objects (getChildren method).

The addition (or removal) of top objects to (or from) the model must be signaled. This is done through EquipmentModelEvents of type ROOT_OBJECT_ADDED, ROOT_OBJECT_REMOVED; and for lower-level objects, through EquipmentContainerEvents to the appropriate parent object.

Since:
JTGO 3.0

Method Summary
 void addEquipmentModelListener(EquipmentModelListener listener)
          Registers an equipment model listener.
 boolean isRoot(IlpRepresentationObject object)
          Deprecated. Please check getParent(object) method instead.
 void removeEquipmentModelListener(EquipmentModelListener listener)
          Unregisters an equipment model listener.
 
Methods inherited from interface ilog.cpl.graph.IlpGraphModel
getChildren, getFrom, getParent, getRootObjects, getTo, isLeaf, isLink, isNode
 

Method Detail

addEquipmentModelListener

void addEquipmentModelListener(EquipmentModelListener listener)
Registers an equipment model listener. Adds a listener that is notified each time a change to this model occurs.

Parameters:
listener - The listener to be registered.

removeEquipmentModelListener

void removeEquipmentModelListener(EquipmentModelListener listener)
Unregisters an equipment model listener.

Parameters:
listener - The listener to be unregistered.

isRoot

boolean isRoot(IlpRepresentationObject object)
Deprecated. Please check getParent(object) method instead.

Returns true if the given object is a root object.

Returns:
true for a given root object; false otherwise.
Deprecated Since:
JTGO4.0


Copyright © 1996-2007 ILOG S.A. All rights reserved.   Documentation homepage.   . All Rights Reserved.