public interface OffsetEventEnablerSearchSession extends OffsetEventEnablerQuerySession
This session provides methods for searching among
OffsetEventEnabler
objects. The search query is constructed using
the OffsetEventEnablerQuery.
getOffsetEventEnablersByQuery()
is the basic search
method and returns a list of OffsetEventEnablers.
A more
advanced search may be performed with
getOffsetEventEnablersBySearch().
It accepts an
OffsetEventEnablerSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
calendaring. getOffsetEventEnablersBySearch()
returns an
OffsetEventEnablerSearchResults
that can be used to access
the resulting OffsetEventEnablerList
or be used to perform
a search within the result set through OffsetEventEnablerSearch.
This session defines views that offer differing behaviors for searching.
OffsetEventEnablers
may have a query record indicated
by their respective record types. The query record is accessed via the
OffsetEventEnablerQuery.
Modifier and Type | Method and Description |
---|---|
OffsetEventEnablerQuery |
getOffsetEventEnablerQueryFromInspector(OffsetEventEnablerQueryInspector offsetEventEnablerQueryInspector)
Gets an offset event enabler query from an inspector.
|
OffsetEventEnablerSearchResults |
getOffsetEventEnablersBySearch(OffsetEventEnablerQuery offsetEventEnablerQuery,
OffsetEventEnablerSearch offsetEventEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
OffsetEventEnablerSearch |
getOffsetEventEnablerSearch()
Gets an offset event enabler search.
|
OffsetEventEnablerSearchOrder |
getOffsetEventEnablerSearchOrder()
Gets an offset event enabler search order.
|
canSearchOffsetEventEnablers, getCalendar, getCalendarId, getOffsetEventEnablerQuery, getOffsetEventEnablersByQuery, useFederatedCalendarView, useIsolatedCalendarView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
OffsetEventEnablerSearch getOffsetEventEnablerSearch()
mandatory
- This method must be implemented. OffsetEventEnablerSearchOrder getOffsetEventEnablerSearchOrder()
OffsetEventEnablerSearchOrder
is supplied to an
OffsetEventEnablerSearch
to specify the ordering of results.mandatory
- This method must be implemented. OffsetEventEnablerSearchResults getOffsetEventEnablersBySearch(OffsetEventEnablerQuery offsetEventEnablerQuery, OffsetEventEnablerSearch offsetEventEnablerSearch) throws OperationFailedException, PermissionDeniedException
offsetEventEnablerQuery
- the offset event enabler queryoffsetEventEnablerSearch
- the offset event enabler searchNullArgumentException
- offsetEventEnablerQuery
or offsetEventEnablerSearch
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- offsetEventEnablerQuery
or offsetEventEnablerSearch
is not of
this servicemandatory
- This method must be implemented. OffsetEventEnablerQuery getOffsetEventEnablerQueryFromInspector(OffsetEventEnablerQueryInspector offsetEventEnablerQueryInspector)
OffsetEventEnablerSearchResults.
offsetEventEnablerQueryInspector
- an offset event enabler query
inspectorNullArgumentException
-
offsetEventEnablerQueryInspector
is null
UnsupportedException
-
offsetEventEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.