ilog.cpl.model

Interface IlpObject

All Superinterfaces:

IlpAttributeValueHolder

All Known Implementing Classes:

IlpBeansObject, IlpDefaultObject, IlpObjectSupport, IltAbstractLink, IltAlarm, IltBTS, IltBTSAntenna, IltCard, IltCardCarrier, IltCardItem, IltEmptySlot, IltGroup, IltLed, IltLinearGroup, IltLink, IltLinkBundle, IltLinkSet, IltNetworkElement, IltObject, IltOffPageConnector, IltPolyGroup, IltPort, IltRectGroup, IltShelf, IltShelfItem

public interface IlpObject
extends IlpAttributeValueHolder

ILOG CPL Business Object interface.

An IlpObject instance may be represented by representation objects.

It may also be contained in a data source.

An IlpObject instance notifies listeners when the value of an attribute changes.

Since:

JTGO 3.0

See Also:

IlpDataSource, IlpRepresentationObject

Field Summary

Fields inherited from interface ilog.cpl.model.IlpAttributeValueHolder

VALUE_NOT_SET

Method Summary

Modifier and Type	Method and Description
Object	getIdentifier() Returns the identifier of the IlpObject.
IlpClass	getIlpClass() Retrieves the IlpClass of this object.
void	initializeDefaultValues() This method initializes the attribute values of the object with the default attribute values, if there are any.

Methods inherited from interface ilog.cpl.model.IlpAttributeValueHolder

addAttributeValueListener, fireEvent, getAttributeGroup, getAttributeValue, getAttributeValue, hasAttributeValue, removeAttributeValueListener, setAttributeValue, setAttributeValue

Method Detail

getIdentifier

Object getIdentifier()

Returns the identifier of the IlpObject. This identifier is an Object that can be used to identify and retrieve this IlpObject. It must be unique.

The identifier is given when the IlpObject is created. It can be either a String or another kind of Java object.

If the identifier is a String, the code which creates an IlpObject and assigns its identifier must ensure that the identifier is unique.

If the identifier is another kind of object, it must satisfy some constraints:

• The identifier must be convertible to String, by use of the IlpTypeConverter installed in the IlpContext. The default type converter uses the toString() method in order to convert unknown objects to String.
• The String that results from this conversion must be unique.
• It must be possible to create or retrieve the identifier, given its corresponding String, by use of the IlpTypeConverter installed in the IlpContext. The default type converter uses a constructor with a single String argument in order to create instances of unknown classes.
• The identifier cannot itself be an instance of IlpObject.

Returns:

The identifier of the IlpObject.

See Also:

IlpTypeConverter

getIlpClass

IlpClass getIlpClass()

Retrieves the IlpClass of this object.

Returns:

The IlpClass of this object.

initializeDefaultValues

void initializeDefaultValues()

This method initializes the attribute values of the object with the default attribute values, if there are any. Note that this method does not reset an attribute value that has been set to its default value. It will change the attributes that have a default value (which is not VALUE_NOT_SET) AND that have not been set in another way, using, for example, setAttributeValue.