public interface BuildingSearchSession extends BuildingQuerySession
This session provides methods for searching Building
objects. The search query is constructed using the BuildingQuery.
The building record Type
also specifies the record
for the building query.
getBuildingsByQuery()
is the basic search method and
returns a list of Building
elements. A more advanced search
may be performed with getBuildingsBySearch().
It accepts a
BuildingSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getBuildingsBySearch()
returns a
BuildingSearchResults
that can be used to access the resulting
BuildingList
or be used to perform a search within the
result set through BuildingSearch.
Buildings may have a query record indicated by their respective record
types. The query record is accessed via the BuildingQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
BuildingQuery |
getBuildingQueryFromInspector(BuildingQueryInspector buildingQueryInspector)
Gets a building query from an inspector.
|
BuildingSearchResults |
getBuildingsBySearch(BuildingQuery buildingQuery,
BuildingSearch buildingSearch)
Gets the search results matching the given search.
|
BuildingSearch |
getBuildingSearch()
Gets a building search.
|
BuildingSearchOrder |
getBuildingSearchOrder()
Gets a building search order.
|
canSearchBuildings, getBuildingQuery, getBuildingsByQuery, getCampus, getCampusId, useFederatedCampusView, useIsolatedCampusView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BuildingSearch getBuildingSearch()
mandatory
- This method must be implemented. BuildingSearchOrder getBuildingSearchOrder()
BuildingSearchOrder
is supplied to a BuildingSearch
to specify the ordering
of results.mandatory
- This method must be implemented. BuildingSearchResults getBuildingsBySearch(BuildingQuery buildingQuery, BuildingSearch buildingSearch) throws OperationFailedException, PermissionDeniedException
buildingQuery
- the building querybuildingSearch
- the building searchNullArgumentException
- buildingQuery
or
buildingSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- buildingQuery
or
buildingSearch
is not of this servicemandatory
- This method must be implemented. BuildingQuery getBuildingQueryFromInspector(BuildingQueryInspector buildingQueryInspector)
BuildingSearchResults.
buildingQueryInspector
- a query inspectorNullArgumentException
- buildingQueryInspector
is null
UnsupportedException
- buildingQueryInspector
is not of this servicemandatory
- This method must be implemented.