public interface RoomQuerySession extends OsidSession
This session provides methods for searching Room
objects. The search query is constructed using the RoomQuery.
The building record Type
also specifies the record
for the building query.
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.
Modifier and Type | Method and 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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCampusId()
Campus
Id
associated with this
session. Campus Id
associated with this sessionmandatory
- This method must be implemented. Campus getCampus() throws OperationFailedException, PermissionDeniedException
Campus
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchRooms()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not wish to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedCampusView()
mandatory
- This method is must be implemented. void useIsolatedCampusView()
mandatory
- This method is must be implemented. RoomQuery getRoomQuery()
mandatory
- This method must be implemented. RoomList getRoomsByQuery(RoomQuery roomQuery) throws OperationFailedException, PermissionDeniedException
roomQuery
- the room query RoomList
NullArgumentException
- roomQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- roomQuery
is not
of this servicemandatory
- This method must be implemented.