public interface RecurringEventEnablerSearchSession extends RecurringEventEnablerQuerySession
This session provides methods for searching among
RecurringEventEnabler
objects. The search query is constructed
using the RecurringEventEnablerQuery.
getRecurringEventEnablersByQuery()
is the basic search
method and returns a list of RecurringEventEnablers.
A more
advanced search may be performed with
getRecurringEventEnablerBySearch().
It accepts a
RecurringEventEnabler
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
calendaring. geRecurringEventEnablersBySearch()
returns a
RecurringEventEnablerSearchResults
that can be used to
access the resulting RecurringEventEnablerList
or be used
to perform a search within the result set through
RecurringEventEnablerSearch.
This session defines views that offer differing behaviors for searching.
RecurringEventEnablers
may have a query record
indicated by their respective record types. The query record is accessed
via the RecurringEventEnablerQuery.
Modifier and Type | Method and Description |
---|---|
RecurringEventEnablerQuery |
getRecurringEventEnablerQueryFromInspector(RecurringEventEnablerQueryInspector recurringEventEnablerQueryInspector)
Gets a recurring event enabler query from an inspector.
|
RecurringEventEnablerSearchResults |
getRecurringEventEnablersBySearch(RecurringEventEnablerQuery recurringEventEnablerQuery,
RecurringEventEnablerSearch recurringEventEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
RecurringEventEnablerSearch |
getRecurringEventEnablerSearch()
Gets a recurring event enabler search.
|
RecurringEventEnablerSearchOrder |
getRecurringEventEnablerSearchOrder()
Gets a recurring event enabler search order.
|
canSearchRecurringEventEnablers, getCalendar, getCalendarId, getRecurringEventEnablerQuery, getRecurringEventEnablersByQuery, useFederatedCalendarView, useIsolatedCalendarView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
RecurringEventEnablerSearch getRecurringEventEnablerSearch()
mandatory
- This method must be implemented. RecurringEventEnablerSearchOrder getRecurringEventEnablerSearchOrder()
RecurringEventEnablerSearchOrder
is supplied to a
RecurringEventEnablerSearch
to specify the ordering of
results.mandatory
- This method must be implemented. RecurringEventEnablerSearchResults getRecurringEventEnablersBySearch(RecurringEventEnablerQuery recurringEventEnablerQuery, RecurringEventEnablerSearch recurringEventEnablerSearch) throws OperationFailedException, PermissionDeniedException
recurringEventEnablerQuery
- the recurring event enabler queryrecurringEventEnablerSearch
- the recurring event enabler searchNullArgumentException
-
recurringEventEnablerQuery
or
recurringEventEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
recurringEventEnablerQuery
or
recurringEventEnablerSearch
is not of this servicemandatory
- This method must be implemented. RecurringEventEnablerQuery getRecurringEventEnablerQueryFromInspector(RecurringEventEnablerQueryInspector recurringEventEnablerQueryInspector)
RecurringEventEnablerSearchResults.
recurringEventEnablerQueryInspector
- a recurring event enabler
query inspectorNullArgumentException
-
recurringEventEnablerQueryInspector
is null
UnsupportedException
-
recurringEventEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.