public interface AvailabilitySearchSession extends AvailabilityQuerySession
This session provides methods for searching among Availability
objects. The search query is constructed using the
AvailabilityQuery.
getAvailabilitiesByQuery()
is the basic search method
and returns a list of Availabilities.
A more advanced
search may be performed with getAvailabilitiesBySearch().
It accepts an AvailabilitySearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as ordering. getAvailabilitiesBySearch()
returns an AvailabilitySearchResults
that can be used to
access the resulting AvailabilityList
or be used to perform
a search within the result set through AvailabilitySearch.
This session defines views that offer differing behaviors for searching.
Availabilitys may have a query record indicated by their respective
record types. The query record is accessed via the
AvailabilityQuery.
Modifier and Type | Method and Description |
---|---|
AvailabilitySearchResults |
getAvailabilitiesBySearch(AvailabilityQuery availabilityQuery,
AvailabilitySearch availabilitySearch)
Gets the search results matching the given search query using the
given search.
|
AvailabilityQuery |
getAvailabilityQueryFromInspector(AvailabilityQueryInspector availabilityQueryInspector)
Gets an availability query from an inspector.
|
AvailabilitySearch |
getAvailabilitySearch()
Gets an availability search.
|
AvailabilitySearchOrder |
getAvailabilitySearchOrder()
Gets an availability search order.
|
canSearchAvailabilities, getAvailabilitiesByQuery, getAvailabilityQuery, getFoundry, getFoundryId, useFederatedFoundryView, useIsolatedFoundryView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AvailabilitySearch getAvailabilitySearch()
mandatory
- This method must be implemented. AvailabilitySearchOrder getAvailabilitySearchOrder()
AvailabilitySearchOrder
is supplied to an AvailabilitySearch
to specify
the ordering of results.mandatory
- This method must be implemented. AvailabilitySearchResults getAvailabilitiesBySearch(AvailabilityQuery availabilityQuery, AvailabilitySearch availabilitySearch) throws OperationFailedException, PermissionDeniedException
availabilityQuery
- the availability queryavailabilitySearch
- the availability searchNullArgumentException
- availabilityQuery
or availabilitySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- availabilityQuery
or availabilitySearch
is not of this servicemandatory
- This method must be implemented. AvailabilityQuery getAvailabilityQueryFromInspector(AvailabilityQueryInspector availabilityQueryInspector)
AvailabilitySearchResults.
availabilityQueryInspector
- an availability query inspectorNullArgumentException
-
availabilityQueryInspector
is null
UnsupportedException
-
availabilityQueryInspector
is not of this servicemandatory
- This method must be implemented.