Package com.sap.tc.cmi.util

Contains interfaces and classes dealing with change eventing on model objects and collections of model objects as well as support for paging (reading model object collections in pages from a backend system).

See:
Description

Interface Summary

ICMIListIterator	Lightweight version of an list iterator.
ICMIModificationCount	Interface for classes which support tracking of modifications.
ICMIObservableList	List that informs about changes.
ICMIObservableListChangeListener	Methods that a listener must implement to be informed about changes in an ICMIObservableList.
ICMIObservableListChangeListener02	Duplicate of ICMIObservableListChangeListener with a revised contract.
ICMIObservableModelClass	Interface for model classes that can notify registered listeners about changes.
ICMIPageableList	Contract for a list implementation that not necessarily keeps all its elements in memory.
ICMIRelationRoleChangeListener	Listener interface for model consumers that want to be notified about changes in a relation role of an ICMIObservableModelClass.
ICMIValueSetProvider	Provides access to dynamic value sets; this is only a preliminary version of the interface and will most probably change after AP4.
ICMIValueSetProvider02	Identifies value sets as dynamic value sets.

Class Summary

CMIAbstractObservableList	Abstract implementation of the ICMIObservableList interface.
CMIObservableListEvent	Event object that describes changes in an ICMIObservableList.
CMIRelationRoleEvent	Describes a change in a relation role of an observed model object.
CMIThreadContextUtils	Provides a primitive data storage (context) that allows different CMI consumers running in the same thread to exchange data without knowing/referencing each other.

Package com.sap.tc.cmi.util Description

Contains interfaces and classes dealing with change eventing on model objects and collections of model objects as well as support for paging (reading model object collections in pages from a backend system).

Analogously to the package com.sap.tc.cmi.model interfaces named ICMI*02 are extensions of interfaces named ICMI* which originate from previously released CMI versions.

The interface ICMIObservableList and the implementing abstract class CMIAbstractObservableList define list based collections of model objects allowing indexed access of the model objects contained in the collection and supporting registration of change listeners (ICMIObservableListChangeListener02 or ICMIObservableListChangeListener). Events sent by an ICMIObservableList are represented by CMIObservableListEvent.

Similarly, eventing on relation roles of model objects is defined through

• ICMIObservableModelClass: Interface for a model class supporting relation role eventing; allows registration of role listeners
• ICMIRelationRoleChangeListener: Interface for role listeners defining change event callback methods.
• CMIRelationRoleEvent: Class defining events sent to listener on a relation role change

A model object collection class has to implement ICMIPageableList to support paging. The interface ICMIListIterator may be implemented by list iterators for such model object collections to provide performant iteration over model objects already prepared for paging, cf. ICMIPageableList.

Implementation of ICMIModificationCount provides a model class the possibility to signal that its state has changed so that client can react on that change.