public interface FloorSearchSession extends FloorQuerySession
This session provides methods for searching Floor
objects. The search query is constructed using the FloorQuery.
The floor record Type
also specifies the record for
the floor query.
getFloorsByQuery()
is the basic search method and
returns a list of Floor
elements. A more advanced search
may be performed with getFloorsBySearch().
It accepts a
FloorSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getFlooreBySearch()
returns a
FloorSearchResults
that can be used to access the resulting
FloorList
or be used to perform a search within the result set
through FloorSearch.
Floors may have a query record indicated by their respective record
types. The query record is accessed via the FloorQuery.
The
returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
FloorQuery |
getFloorQueryFromInspector(FloorQueryInspector floorQueryInspector)
Gets an entry query from an inspector.
|
FloorSearchResults |
getFloorsBySearch(FloorQuery floorQuery,
FloorSearch floorSearch)
Gets the search results matching the given search.
|
FloorSearch |
getFloorSearch()
Gets a floor search.
|
FloorSearchOrder |
getFloorSearchOrder()
Gets a floor search order.
|
canSearchFloors, getCampus, getCampusId, getFloorQuery, getFloorsByQuery, useFederatedCampusView, useIsolatedCampusView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
FloorSearch getFloorSearch()
mandatory
- This method must be implemented. FloorSearchOrder getFloorSearchOrder()
FloorSearchOrder
is
supplied to a FloorSearch
to specify the ordering of
results.mandatory
- This method must be implemented. FloorSearchResults getFloorsBySearch(FloorQuery floorQuery, FloorSearch floorSearch) throws OperationFailedException, PermissionDeniedException
floorQuery
- the floor queryfloorSearch
- the floor searchNullArgumentException
- floorQuery
or
floorSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- floorQuery
or
floorSearch
is not of this servicemandatory
- This method must be implemented. FloorQuery getFloorQueryFromInspector(FloorQueryInspector floorQueryInspector)
FloorSearchResults.
floorQueryInspector
- a query inspectorNullArgumentException
- floorQueryInspector
is null
UnsupportedException
- floorQueryInspector
is not of this servicemandatory
- This method must be implemented.