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.
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.
|
canSearchRooms, getCampus, getCampusId, getRoomQuery, getRoomsByQuery, useFederatedCampusView, useIsolatedCampusView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
RoomSearch getRoomSearch()
mandatory
- This method must be implemented. RoomSearchOrder getRoomSearchOrder()
RoomSearchOrder
is
supplied to a RoomSearch
to specify the ordering of
results.mandatory
- This method must be implemented. RoomSearchResults getRoomsBySearch(RoomQuery roomQuery, RoomSearch roomSearch) throws OperationFailedException, PermissionDeniedException
roomQuery
- the room queryroomSearch
- the room searchNullArgumentException
- roomQuery
or
roomSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- roomQuery
or
roomSearch
is not of this servicemandatory
- This method must be implemented. RoomQuery getRoomQueryFromInspector(RoomQueryInspector roomQueryInspector)
RoomSearchResults.
roomQueryInspector
- a query inspectorNullArgumentException
- roomQueryInspector
is null
UnsupportedException
- roomQueryInspector
is not of this servicemandatory
- This method must be implemented.