public interface SupersedingEventSearchSession extends SupersedingEventQuerySession
This session provides methods for searching SupersedingEvent
objects. The search query is constructed using the
SupersedingEventQuery.
The superseding event record Type
also specifies the record for the superseding event query.
getSupersedingEventsByQuery()
is the basic search
method and returns a list of SupersedingEvents.
A more
advanced search may be performed with
getSupersedingEventsBySearch().
It accepts a
SupersedingEventSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getSupersedingEventsBySearch()
returns a
SupersedingEventSearchResults
that can be used to access the
resulting SupersedingEventList
or be used to perform a
search within the result set through SupersedingEventSearch.
This session defines views that offer differing behaviors for searching.
Superseding events may have a query record indicated by their
respective record types. The query record is accessed via the
SupersedingEventQuery.
Modifier and Type | Method and Description |
---|---|
SupersedingEventQuery |
getSupersedingEventQueryFromInspector(SupersedingEventQueryInspector supersedingEventQueryInspector)
Gets a superseding event query from an inspector.
|
SupersedingEventSearchResults |
getSupersedingEventsBySearch(SupersedingEventQuery supersedingEventQuery,
SupersedingEventSearch supersedingEventSearch)
Gets the search results matching the given search query using the
given search.
|
SupersedingEventSearch |
getSupersedingEventSearch()
Gets a superseding event search.
|
SupersedingEventSearchOrder |
getSupersedingEventSearchOrder()
Gets a superseding event search order.
|
canSearchSupersedingEvents, getCalendar, getCalendarId, getSupersedingEventQuery, getSupersedingEventsByQuery, useFederatedCalendarView, useIsolatedCalendarView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
SupersedingEventSearch getSupersedingEventSearch()
mandatory
- This method must be implemented. SupersedingEventSearchOrder getSupersedingEventSearchOrder()
SupersedingEventSearchOrder
is supplied to a
SupersedingEventSearch
to specify the ordering of results.mandatory
- This method must be implemented. SupersedingEventSearchResults getSupersedingEventsBySearch(SupersedingEventQuery supersedingEventQuery, SupersedingEventSearch supersedingEventSearch) throws OperationFailedException, PermissionDeniedException
supersedingEventQuery
- the superseding search querysupersedingEventSearch
- the superseding searchNullArgumentException
- supersedingEventQuery
or supersedingEventSearch
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- supersedingEventQuery
is not of this servicemandatory
- This method must be implemented. SupersedingEventQuery getSupersedingEventQueryFromInspector(SupersedingEventQueryInspector supersedingEventQueryInspector)
SupersedingEventSearchResults.
supersedingEventQueryInspector
- a superseding event query
inspectorNullArgumentException
-
supersedingEventQueryInspector
is null
UnsupportedException
-
supersedingEventQueryInspector
is not of this servicemandatory
- This method must be implemented.