public interface SupersedingEventEnablerSearchSession extends SupersedingEventEnablerQuerySession
This session provides methods for searching among
SupersedingEventEnabler
objects. The search query is constructed
using the SupersedingEventEnablerQuery.
getSupersedingEventEnablersByQuery()
is the basic
search method and returns a list of SupersedingEventEnablers.
A more advanced search may be performed with
getSupersedingEventEnablersBySearch().
It accepts a
SupersedingEventEnablerSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as calendaring. getSupersedingEventEnablersBySearch()
returns a SupersedingEventEnablerSearchResults
that can be
used to access the resulting SupersedingEventEnablerList
or
be used to perform a search within the result set through
SupersedingEventEnablerSearch.
This session defines views that offer differing behaviors for searching.
SupersedingEventEnablers
may have a query record
indicated by their respective record types. The query record is accessed
via the SupersedingEventEnablerQuery.
Modifier and Type | Method and Description |
---|---|
SupersedingEventEnablerQuery |
getSupersedingEventEnablerQueryFromInspector(SupersedingEventEnablerQueryInspector supersedingEventEnablerQueryInspector)
Gets a superseding event enabler query from an inspector.
|
SupersedingEventEnablerSearchResults |
getSupersedingEventEnablersBySearch(SupersedingEventEnablerQuery supersedingEventEnablerQuery,
SupersedingEventEnablerSearch supersedingEventEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
SupersedingEventEnablerSearch |
getSupersedingEventEnablerSearch()
Gets a superseding event enabler search.
|
SupersedingEventEnablerSearchOrder |
getSupersedingEventEnablerSearchOrder()
Gets a superseding event enabler search order.
|
canSearchSupersedingEventEnablers, getCalendar, getCalendarId, getSupersedingEventEnablerQuery, getSupersedingEventEnablersByQuery, useFederatedCalendarView, useIsolatedCalendarView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
SupersedingEventEnablerSearch getSupersedingEventEnablerSearch()
mandatory
- This method must be implemented. SupersedingEventEnablerSearchOrder getSupersedingEventEnablerSearchOrder()
SupersedingEventEnablerSearchOrder
is supplied to a
SupersedingEventEnablerSearch
to specify the ordering of
results.mandatory
- This method must be implemented. SupersedingEventEnablerSearchResults getSupersedingEventEnablersBySearch(SupersedingEventEnablerQuery supersedingEventEnablerQuery, SupersedingEventEnablerSearch supersedingEventEnablerSearch) throws OperationFailedException, PermissionDeniedException
supersedingEventEnablerQuery
- the superseding event enabler
querysupersedingEventEnablerSearch
- the superseding event enabler
searchNullArgumentException
-
supersedingEventEnablerQuery
or
supersedingEventEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
supersedingEventEnablerQuery
or
supersedingEventEnablerSearch
is not of this servicemandatory
- This method must be implemented. SupersedingEventEnablerQuery getSupersedingEventEnablerQueryFromInspector(SupersedingEventEnablerQueryInspector supersedingEventEnablerQueryInspector)
SupersedingEventEnablerSearchResults.
supersedingEventEnablerQueryInspector
- a superseding event
enabler query inspectorNullArgumentException
-
supersedingEventEnablerQueryInspector
is null
UnsupportedException
-
supersedingEventEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.