Package com.sap.tc.cmi.sorting

Contains interfaces and classes needed to define sorting of model objects in the Common Model Interface CMI.

See:
Description

Interface Summary

ICMISortable	Interface marking a model object collection ICMIModelObjectCollection02 or ICMIQuery as sortable.
ICMISortableQuery	Composite interface that represents a query with a sortable result.

Class Summary

CMIComparisonRule	Enumeration of the comparison rules that are available for sorting.
CMISortByColumn	Instructs a collection to order its data by the value of a single column.
CMISortCriteriaList	(Complex) sort criterion that consists of a prioritized list of (simpler) SortCriteria.
CMISortCriterion	Abstract representation of a sort criterion.

Exception Summary

CMIIllegalSortCriterionException

Exception to be thrown by model implementations if a given sort criterion can't be processed.

Package com.sap.tc.cmi.sorting Description

Contains interfaces and classes needed to define sorting of model objects in the Common Model Interface CMI. As sorting is an optional CMI feature a CMI implementation does not have to implement any of the interfaces in this package.

The interface ICMISortable is implemented by a query if the result is to be sortable (ICMISortableQuery) or by a class representing a collection of model objects if the collection can be sorted.

A ICMISortable is assigned a CMISortCriterion to define the criterion for sorting; the package contains two subinterfaces CMISortByColumn (defines sorting by a column which is in the context of a model class defined as model class property) and CMISortCriteriaList (allows combination of other sort criteria).

The class CMIComparisonRule is for enumeration of rules used for the comparison of model objects during sort.