Interface RoomSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RoomSearch
extends OsidSearch

The search interface for governing room searches.

Method Summary

Modifier and Type	Method	Description
RoomSearchRecord	getRoomSearchRecord(Type roomSearchRecordType)	Gets the room search record corresponding to the given room search record Type.
void	orderRoomResults(RoomSearchOrder roomSearchOrder)	Specify an ordering to the search results.
void	searchAmongRooms(IdList roomIds)	Execute this search among the given list of rooms.

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

searchAmongRooms

void searchAmongRooms(IdList roomIds)

Execute this search among the given list of rooms.

Parameters:

roomIds - list of rooms

Throws:

NullArgumentException - roomIds is null

Compliance:

mandatory - This method must be implemented.

orderRoomResults

void orderRoomResults(RoomSearchOrder roomSearchOrder)

Specify an ordering to the search results.

Parameters:

roomSearchOrder - room search order

Throws:

NullArgumentException - roomSearchOrder is null

UnsupportedException - roomSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRoomSearchRecord

RoomSearchRecord getRoomSearchRecord(Type roomSearchRecordType)
                              throws OperationFailedException

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

Parameters:

roomSearchRecordType - a room search record type

Returns:

the room search record

Throws:

NullArgumentException - roomSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(roomSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.