org.osid.mapping

Interface LocationSearchOrder

All Superinterfaces:

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

public interface LocationSearchOrder
extends OsidObjectSearchOrder, OsidFederateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
LocationSearchOrderRecord	getLocationSearchOrderRecord(Type locationRecordType) Gets the location search order record corresponding to the given location record Type.
void	orderByDistance(SearchOrderStyle style) Orders the results by distance.

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

Method Detail

orderByDistance

void orderByDistance(SearchOrderStyle style)

Orders the results by distance.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getLocationSearchOrderRecord

LocationSearchOrderRecord getLocationSearchOrderRecord(Type locationRecordType)
                                                       throws OperationFailedException

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

Parameters:

locationRecordType - a location record type

Returns:

the location search order record

Throws:

NullArgumentException - locationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(locationRecordType) is false

Compliance:

mandatory - This method must be implemented.