public interface AvailabilityEnablerSearchSession extends AvailabilityEnablerQuerySession
This session provides methods for searching among
AvailabilityEnabler
objects. The search query is constructed using
the AvailabilityEnableryQuery.
getAvailabilityEnablersByQuery()
is the basic search
method and returns a list of AvailabilityEnablers.
A more
advanced search may be performed with
getAvailabilityEnablersBySearch().
It accepts an
AvailabilityEnablerSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
resourcing. getAvailabilityEnablersBySearch()
returns an
AvailabilityEnablerSearchResults
that can be used to access
the resulting AvailabilityEnablerList
or be used to perform
a search within the result set through AvailabilityEnablerSearch.
This session defines views that offer differing behaviors for searching.
AvailabilityEnablers
may have an availability enabler
query record indicated by their respective record types. The availability
enabler record query is accessed via the AvailabilityEnablerQuery.
Modifier and Type | Method and Description |
---|---|
AvailabilityEnablerQuery |
getAvailabilityEnablerQueryFromInspector(AvailabilityEnablerQueryInspector availabilityEnablerQueryInspector)
Gets an availability enabler query from an inspector.
|
AvailabilityEnablerSearchResults |
getAvailabilityEnablersBySearch(AvailabilityEnablerQuery availabilityEnablerQuery,
AvailabilityEnablerSearch availabilityEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
AvailabilityEnablerSearch |
getAvailabilityEnablerSearch()
Gets an availability enabler search.
|
AvailabilityEnablerSearchOrder |
getAvailabilityEnablerSearchOrder()
Gets an availability enabler search order.
|
canSearchAvailabilityEnablers, getAvailabilityEnablerQuery, getAvailabilityEnablersByQuery, getFoundry, getFoundryId, useFederatedFoundryView, useIsolatedFoundryView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AvailabilityEnablerSearch getAvailabilityEnablerSearch()
mandatory
- This method must be implemented. AvailabilityEnablerSearchOrder getAvailabilityEnablerSearchOrder()
AvailabilityEnablerSearchOrder
is supplied to an
AvailabilityEnablerSearch
to specify the ordering of results.mandatory
- This method must be implemented. AvailabilityEnablerSearchResults getAvailabilityEnablersBySearch(AvailabilityEnablerQuery availabilityEnablerQuery, AvailabilityEnablerSearch availabilityEnablerSearch) throws OperationFailedException, PermissionDeniedException
availabilityEnablerQuery
- the availability enabler queryavailabilityEnablerSearch
- the availability enabler searchNullArgumentException
- availabilityEnablerQuery
or availabilityEnablerSearch
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- availabilityEnablerQuery
or availabilityEnablerSearch
is not of
this servicemandatory
- This method must be implemented. AvailabilityEnablerQuery getAvailabilityEnablerQueryFromInspector(AvailabilityEnablerQueryInspector availabilityEnablerQueryInspector)
AvailabilityEnablerSearchResults.
availabilityEnablerQueryInspector
- an availability enabler
query inspectorNullArgumentException
-
availabilityEnablerQueryInspector
is null
UnsupportedException
-
availabilityEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.