ilog.views.appframe.settings

Interface IlvSettings.IDResolver

All Known Implementing Classes:

IlvSettings.IDAttributeMapper

Enclosing class:

IlvSettings

public static interface IlvSettings.IDResolver

Provides ID values for objects of the settings models.

See Also:

IlvSettings.getID(java.lang.Object, java.lang.String, ilog.views.appframe.settings.IlvSettingsModel), IlvSettings.setID(java.lang.Object, java.lang.Object, java.lang.String, ilog.views.appframe.settings.IlvMutableSettingsModel), IlvSettings.addIDResolver(ilog.views.appframe.settings.IlvSettings.IDResolver), IlvSettings.removeIDResolver(ilog.views.appframe.settings.IlvSettings.IDResolver)

Method Summary

Modifier and Type	Method and Description
Object	getID(Object element, String type, IlvSettingsModel model) Returns the ID value for the object.
boolean	setID(Object element, Object id, String type, IlvMutableSettingsModel model) Sets the specified ID value to the specified element.

Method Detail

getID

Object getID(Object element,
             String type,
             IlvSettingsModel model)

Returns the ID value for the object. If no ID is used for this element, null will be returned.

Parameters:

element - The settings element to retrieve the ID from.

type - The settings type of the specified element.

model - The settings model that owns the specified element.

Returns:

The ID value of the specified settings element.

See Also:

setID(java.lang.Object, java.lang.Object, java.lang.String, ilog.views.appframe.settings.IlvMutableSettingsModel)

setID

boolean setID(Object element,
              Object id,
              String type,
              IlvMutableSettingsModel model)

Sets the specified ID value to the specified element.

Parameters:

element - The settings element to set the ID to.

id - The ID value to set the specified element to.

type - The settings type of the specified element.

model - The settings model that owns the specified element.

Returns:

true if the ID value could be set to the settings element or false if no ID is defined for the specified settings type.