Interface RoomSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RoomSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
RoomQueryInspector	getRoomQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
RoomList	getRooms()	Gets the room list resulting from a search.
RoomSearchResultsRecord	getRoomSearchResultsRecord(Type roomSearchRecordType)	Gets the room search results record corresponding to the given room search record Type .This method must be used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getRooms

RoomList getRooms()

Gets the room list resulting from a search.

Returns:

the room list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getRoomQueryInspector

RoomQueryInspector getRoomQueryInspector()

Gets the inspector for the query to examine the terns used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getRoomSearchResultsRecord

RoomSearchResultsRecord getRoomSearchResultsRecord(Type roomSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

roomSearchRecordType - a room search record type

Returns:

the room search results record

Throws:

NullArgumentException - roomSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(roomSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.