org.osid.room

Interface RoomSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, RoomQuerySession

public interface RoomSearchSession
extends RoomQuerySession

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.

Method Summary

Methods

Modifier and Type	Method and Description
RoomQuery	getRoomQueryFromInspector(RoomQueryInspector roomQueryInspector) Gets an entry query from an inspector.
RoomSearchResults	getRoomsBySearch(RoomQuery roomQuery, RoomSearch roomSearch) Gets the room search results matching the given search.
RoomSearch	getRoomSearch() Gets a room search.
RoomSearchOrder	getRoomSearchOrder() Gets a room search order.

Methods inherited from interface org.osid.room.RoomQuerySession

canSearchRooms, getCampus, getCampusId, getRoomQuery, getRoomsByQuery, useFederatedCampusView, useIsolatedCampusView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getRoomSearch

RoomSearch getRoomSearch()

Gets a room search.

Returns:

the room search

Compliance:

mandatory - This method must be implemented.

getRoomSearchOrder

RoomSearchOrder getRoomSearchOrder()

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

Returns:

the room search order

Compliance:

mandatory - This method must be implemented.

getRoomsBySearch

RoomSearchResults getRoomsBySearch(RoomQuery roomQuery,
                                 RoomSearch roomSearch)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets the room search results matching the given search.

Parameters:

roomQuery - the room query

roomSearch - the room search

Returns:

the room search results

Throws:

NullArgumentException - roomQuery or roomSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - roomQuery or roomSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getRoomQueryFromInspector

RoomQuery getRoomQueryFromInspector(RoomQueryInspector roomQueryInspector)

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

Parameters:

roomQueryInspector - a query inspector

Returns:

the entry query

Throws:

NullArgumentException - roomQueryInspector is null

UnsupportedException - roomQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.