com.sap.tc.cmi.sorting

Interface ICMISortable

All Known Subinterfaces:

ICMISortableQuery

public interface ICMISortable

Interface marking a model object collection ICMIModelObjectCollection02 or ICMIQuery as sortable.

An ICMIModelObjectCollection02 implementing ICMISortable means that a sort order for the collection can be specified at any time. If a model can not or does not want to guarantee that, its collections should not implement ICMISortable, but the access path to the collection should be sortable (relation or query).

An ICMIQuery implementing ICMISortable indicates that the result can be sorted. This is due to the fact, that some model technologies might require definition of sorting criteria before executing the query. Therefore attaching the sorting criteria to the relation access only would lead to some ambiguous behavior (does a call sort or not? Does accessing the relation re-execute the query if the sorting criteria has changed?). To avoid these potential conflicts, sorting can be defined on the query prior to executing it.

Since:

NW Paris MS2

Type Classification:

This interface is part of the Common Model Interface and is intended to be implemented by applications.

Method Summary

CMISortCriterion	getSortCriterion() Returns the sort criterion that describes the current sort order of the data provided by this ICMISortable.
void	setSortCriterion(CMISortCriterion sortCriterion) Sets a new sort criterion for the data provided by this ICMISortable.

Method Detail

setSortCriterion

void setSortCriterion(CMISortCriterion sortCriterion)
                      throws CMIIllegalSortCriterionException

Sets a new sort criterion for the data provided by this ICMISortable.

Parameters:

sortCriterion -

Throws:

CMIIllegalSortCriterionException - if the implementation can't support the given sort criterion.

getSortCriterion

CMISortCriterion getSortCriterion()

Returns the sort criterion that describes the current sort order of the data provided by this ICMISortable.

Returns:

sort criterion

Access Rights

This class can be accessed from:

SC	DC
[sap.com] FRAMEWORK	[sap.com] tc/cmi
[sap.com] FRAMEWORK	[sap.com] tc/cm/ejb/api