OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.RoomSearchSession
Implementsosid.room.RoomQuerySession
Description

This session provides methods for searching Room objects. The search query is constructed using the RoomQuery. The room record Type also specifies the record for the room query.

getRoomsByQuery() is the basic search method and returns a list of Campus elements. A more advanced search may be performed with getRoomsBySearch(). It accepts a RoomSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRoomsBySearch() returns a RoomSearchResults that can be used to access the resulting RoomList or be used to perform a search within the result set through RoomSearch.

Rooms may have a query record indicated by their respective record types. The query record is accessed via the RoomQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetRoomSearch
Description

Gets a room search.

Returnosid.room.RoomSearchthe room search
CompliancemandatoryThis method must be implemented.
MethodgetRoomSearchOrder
Description

Gets a room search order. The RoomSearchOrder is supplied to a RoomSearch to specify the ordering of results.

Returnosid.room.RoomSearchOrderthe room search order
CompliancemandatoryThis method must be implemented.
MethodgetRoomsBySearch
Description

Gets the room search results matching the given search.

Parametersosid.room.RoomQueryroomQuerythe room query
osid.room.RoomSearchroomSearchthe room search
Returnosid.room.RoomSearchResultsthe room search results
ErrorsNULL_ARGUMENT roomQuery or roomSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED roomQuery or roomSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRoomQueryFromInspector
Description

Gets an entry query from an inspector. The inspector is available from an RoomSearchResults.

Parametersosid.room.RoomQueryInspectorroomQueryInspectora query inspector
Returnosid.room.RoomQuerythe entry query
ErrorsNULL_ARGUMENT roomQueryInspector is null
UNSUPPORTED roomQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.