org.osid.mapping

Interface MapSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface MapSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
MapSearchOrderRecord	getMapSearchOrderRecord(Type mapRecordType) Gets the map search order record corresponding to the given map Type.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getMapSearchOrderRecord

MapSearchOrderRecord getMapSearchOrderRecord(Type mapRecordType)
                                             throws OperationFailedException

Gets the map search order record corresponding to the given map Type. Multiple retrievals return the same underlying object.

Parameters:

mapRecordType - a map record type

Returns:

the map search order record

Throws:

NullArgumentException - mapRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(mapRecordType) is false

Compliance:

mandatory - This method must be implemented.