public interface RoomSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and 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. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
RoomList getRooms()
IllegalStateException
- list has already been retrievedmandatory
- This method must be implemented. RoomQueryInspector getRoomQueryInspector()
mandatory
- This method must be implemented. RoomSearchResultsRecord getRoomSearchResultsRecord(Type roomSearchRecordType) throws OperationFailedException
Type.
This method must be used to
retrieve an object implementing the requested record.roomSearchRecordType
- a room search record typeNullArgumentException
- roomSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(roomSearchRecordType)
is false
mandatory
- This method must be implemented.