com.sap.tc.cmi.sorting

Interface ICMISortableQuery

All Superinterfaces:

ICMIModelClass, ICMIModelClassExecutable, ICMIQuery, ICMISortable

public interface ICMISortableQuery
extends ICMIQuery, ICMISortable

Composite interface that represents a query with a sortable result. As a query usually requires some kind of round trip or lower layer processing to show a result, the ability to sort the query result has not been attached to the result, but to the query.

Model implementations, that are able to sort the result with/without interaction with their backend, are free to make the result collection an ICMISortable, too.

So a very generic application could behave in the following patterns

 
 if query is sortable
    define sort order before execute, call query, get result
    if result is sortable
      allow resort of result
    else
      reexecute query with new criteria (2)
 else
    execute query
    if result is sortable
      allow sort/resort of result
    else
      sort locally
 
 

Since:

NW Paris MS2

Type Classification:

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

Field Summary

Fields inherited from interface com.sap.tc.cmi.model.ICMIQuery

ROLE_NAME_INPUT_PARAMETER, ROLE_NAME_RESULT

Method Summary

Methods inherited from interface com.sap.tc.cmi.model.ICMIQuery

associatedInputParameterInfo, associatedResultInfo, countOf, execute, getInputParameter, getResult, isDirty

Methods inherited from interface com.sap.tc.cmi.model.ICMIModelClass

associatedModel, associatedModelClassInfo

Methods inherited from interface com.sap.tc.cmi.sorting.ICMISortable

getSortCriterion, setSortCriterion

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] FRAMEWORK	[sap.com] tc/cm/ejb/api	api	BC-JAS-EJB
[sap.com] FRAMEWORK	[sap.com] tc/cmi	default	BC-WD-JAV-RUN