ilog.cpl.sdm.binding

Interface IlpAttributeBindingContext

public interface IlpAttributeBindingContext

This interface defines an API that provides the required runtime information used by bindings (IlpAbstractAttributeBinding) when converting SDM model properties to/from TGO attributes.

It is internally implemented by IlpAbstractSDMAdapter and passed to bindings before performing any conversions.

Since:

JViews 8.7

Method Summary

Modifier and Type	Method and Description
Object	getAttributeValue(String attrName) This method returns a TGO attribute value from the business object participating in this binding, it should only be invoked by IlpAbstractAttributeBinding.convertToAttribute(Object), IlpAbstractAttributeBinding.convertToProperty(Object) or IlpAbstractAttributeBinding.validate(Object).
IlpContext	getContext() Returns the TGO context (IlpContext) set in the TGO data source holding all business objects.
Logger	getLogger() Returns the logger used by the IlpAbstractSDMAdapter, which should be used by this converter to properly log messages.
Object	getPropertyValue(String propName) This method returns a SDM model property value from the business object participating in this binding, it should only be invoked by IlpAbstractAttributeBinding.convertToAttribute(Object), IlpAbstractAttributeBinding.convertToProperty(Object) or IlpAbstractAttributeBinding.validate(Object).
IlpObject	getTgoObject() Returns the TGO business object participating in this binding, it should only be invoked by IlpAbstractAttributeBinding.convertToAttribute(Object), IlpAbstractAttributeBinding.convertToProperty(Object) or IlpAbstractAttributeBinding.validate(Object).

Method Detail

getContext

IlpContext getContext()

Returns the TGO context (IlpContext) set in the TGO data source holding all business objects.

Returns:

The TGO context being used

getLogger

Logger getLogger()

Returns the logger used by the IlpAbstractSDMAdapter, which should be used by this converter to properly log messages.

Returns:

The logger used by the IlpAbstractSDMAdapter

getTgoObject

IlpObject getTgoObject()

Returns the TGO business object participating in this binding, it should only be invoked by IlpAbstractAttributeBinding.convertToAttribute(Object), IlpAbstractAttributeBinding.convertToProperty(Object) or IlpAbstractAttributeBinding.validate(Object).

Note: This object should not be modified by any caller of this method.

Returns:

The TGO business object participating in the binding

getAttributeValue

Object getAttributeValue(String attrName)

This method returns a TGO attribute value from the business object participating in this binding, it should only be invoked by IlpAbstractAttributeBinding.convertToAttribute(Object), IlpAbstractAttributeBinding.convertToProperty(Object) or IlpAbstractAttributeBinding.validate(Object).

For example, TGO attribute position is bound to SDM model properties x and y. When converting from property x to attribute position, the implementation will need to access attribute position to retrieve the current value of y component.

Parameters:

attrName - The attribute to be retrieved

Returns:

The current TGO attribute value

getPropertyValue

Object getPropertyValue(String propName)

This method returns a SDM model property value from the business object participating in this binding, it should only be invoked by IlpAbstractAttributeBinding.convertToAttribute(Object), IlpAbstractAttributeBinding.convertToProperty(Object) or IlpAbstractAttributeBinding.validate(Object).

For example, TGO attribute objectState is bound to a certain SDM model property counter, which counts the number of times the TGO attribute has been updated. When converting from a new attribute value to property counter the implementation will need to access the current counter value.

Parameters:

propName - The property to be retrieved

Returns:

The current SDM model property value