public interface AgencySearchSession extends AgencyQuerySession
This session provides methods for searching among Agency
objects. The search query is constructed using the AgencyQuery.
getAgenciesByQuery()
is the basic search method and
returns a list of Agency
objects.A more advanced search may
be performed with getAgenciesBySearch().
It accepts a
AgencySearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getAgenciesBySearch()
returns a
AgencySearchResults
that can be used to access the resulting
AgencyList
or be used to perform a search within the result
set through AgencySearch.
Agencies may have a query record indicated by their respective record
types. The query record is accessed via the AgencyQuery.
Modifier and Type | Method and Description |
---|---|
AgencySearchResults |
getAgenciesBySearch(AgencyQuery agencyQuery,
AgencySearch agencySearch)
Gets the search results matching the given search query using the
given search.
|
AgencyQuery |
getAgencyQueryFromInspector(AgencyQueryInspector agencyQueryInspector)
Gets an agency query from an inspector.
|
AgencySearch |
getAgencySearch()
Gets an agency search.
|
AgencySearchOrder |
getAgencySearchOrder()
Gets an agency search order.
|
canSearchAgencies, getAgenciesByQuery, getAgencyQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AgencySearch getAgencySearch()
mandatory
- This method must be implemented. AgencySearchOrder getAgencySearchOrder()
AgencySearchOrder
is
supplied to a AgencySearch
to specify the ordering of
results.mandatory
- This method must be implemented. AgencySearchResults getAgenciesBySearch(AgencyQuery agencyQuery, AgencySearch agencySearch) throws OperationFailedException, PermissionDeniedException
agencyQuery
- the agency queryagencySearch
- the agency searchNullArgumentException
- agencyQuery
or
agencySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- agencyQuery
or
agencySearch
is not of this servicemandatory
- This method must be implemented. AgencyQuery getAgencyQueryFromInspector(AgencyQueryInspector agencyQueryInspector)
AgencySearchResults.
agencyQueryInspector
- an agency query inspectorNullArgumentException
- agencyQueryInspector
is null
UnsupportedException
- agencyQueryInspector
is not of this servicemandatory
- This method must be implemented.