Interface MapSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface MapSearch
extends OsidSearch

The search interface for governing map searches.

Method Summary

Modifier and Type	Method	Description
MapSearchRecord	getMapSearchRecord(Type mapSearchRecordType)	Gets the map search record corresponding to the given map search record Type.
void	orderMapResults(MapSearchOrder mapSearchOrder)	Specify an ordering to the search results.
void	searchAmongMaps(IdList mapIds)	Execute this search among the given list of maps.

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

searchAmongMaps

void searchAmongMaps(IdList mapIds)

Execute this search among the given list of maps.

Parameters:

mapIds - list of maps

Throws:

NullArgumentException - mapIds is null

Compliance:

mandatory - This method must be implemented.

orderMapResults

void orderMapResults(MapSearchOrder mapSearchOrder)

Specify an ordering to the search results.

Parameters:

mapSearchOrder - map search order

Throws:

NullArgumentException - mapSearchOrder is null

UnsupportedException - mapSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getMapSearchRecord

MapSearchRecord getMapSearchRecord(Type mapSearchRecordType)
                            throws OperationFailedException

Gets the map search record corresponding to the given map search record Type. This method must be used to retrieve an object implementing the requested record interface along with all of its ancestor interfaces.

Parameters:

mapSearchRecordType - a map search record type

Returns:

the map search record

Throws:

NullArgumentException - mapSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(mapSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.