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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

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

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Method Details

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.