Interface LocationSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface LocationSearch
extends OsidSearch

The search interface for governing location searches.

Method Summary

Modifier and Type	Method	Description
LocationSearchRecord	getLocationSearchRecord(Type locationSearchRecordType)	Gets the record corresponding to the given location search record Type .
void	orderLocationResults(LocationSearchOrder locationSearchOrder)	Specify an ordering to the search results.
void	searchAmongLocations(IdList locationIds)	Execute this search among the given list of locations.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongLocations

void searchAmongLocations(IdList locationIds)

Execute this search among the given list of locations.

Parameters:

locationIds - list of locations

Throws:

NullArgumentException - locationIds is null

Compliance:

mandatory - This method must be implemented.

orderLocationResults

void orderLocationResults(LocationSearchOrder locationSearchOrder)

Specify an ordering to the search results.

Parameters:

locationSearchOrder - location search order

Throws:

NullArgumentException - locationSearchOrder is null

UnsupportedException - locationSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getLocationSearchRecord

LocationSearchRecord getLocationSearchRecord(Type locationSearchRecordType)
                                      throws OperationFailedException

Gets the record corresponding to the given location search record Type . This method is used to retrieve an object implementing the requested record.

Parameters:

locationSearchRecordType - a location search record type

Returns:

the location search record

Throws:

NullArgumentException - locationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(locationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.