Interface RoomSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, RoomQuerySession

public interface RoomSearchSession
extends RoomQuerySession

This session provides methods for searching Rooms. 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface RoomQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchRooms()	Tests if this user can perform susbcription searches.
Campus	getCampus()	Gets the Campus associated with this session.
Id	getCampusId()	Gets the Campus Id associated with this session.
RoomQuery	getRoomQuery()	Gets a room query.
RoomList	getRoomsByQuery(RoomQuery roomQuery)	Gets a list of rooms matching the given room query.
void	useFederatedCampusView()	Federates the view for methods in this session.
void	useIsolatedCampusView()	Isolates the view for methods in this session.

Method Details

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.