public interface CyclicEventSearchSession extends CyclicEventQuerySession
This session provides methods for searching Event
objects. The search query is constructed using the
CyclicEventQuery.
the cyclic event record Type
also
specifies the record for the cyclic event query.
getCyclicEventsByQuery()
is the basic search method and
returns a list of CyclicEvents.
A more advanced search may
be performed with getCyclicEventsBySearch().
It accepts a
CyclicEventSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getCyclicEventsBySearch()
returns a
CyclicEventSearchResults
that can be used to access the resulting
CyclicEventList
or be used to perform a search within the
result set through CyclicEventSearch.
This session defines views that offer differing behaviors for searching.
Cyclic events may have a query record indicated by their respective
record types. The query record is accessed via the
CyclicEventQuery.
Modifier and Type | Method and Description |
---|---|
CyclicEventQuery |
getCyclicEventQueryFromInspector(CyclicEventQueryInspector cyclicEventQueryInspector)
Gets a cyclic event query from an inspector.
|
CyclicEventSearchResults |
getCyclicEventsBySearch(CyclicEventQuery cyclicEventQuery,
CyclicEventSearch cyclicEventSearch)
Gets the search results matching the given search query using the
given search.
|
CyclicEventSearch |
getCyclicEventSearch()
Gets a cyclic event search.
|
CyclicEventSearchOrder |
getCyclicEventSearchOrder()
Gets a cyclic event search order.
|
canSearchCyclicEvents, getCalendar, getCalendarId, getCyclicEventQuery, getCyclicEventsByQuery, useFederatedCalendarView, useIsolatedCalendarView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CyclicEventSearch getCyclicEventSearch()
mandatory
- This method must be implemented. CyclicEventSearchOrder getCyclicEventSearchOrder()
CyclicEventSearchOrder
is supplied to a CyclicEventSearch
to specify
the ordering of results.mandatory
- This method must be implemented. CyclicEventSearchResults getCyclicEventsBySearch(CyclicEventQuery cyclicEventQuery, CyclicEventSearch cyclicEventSearch) throws OperationFailedException, PermissionDeniedException
cyclicEventQuery
- the cyclic event search querycyclicEventSearch
- the cyclic event searchNullArgumentException
- cyclicEventQuery
or cyclicEventSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- cyclicEventSearch
or cyclicEventQuery
is not of this servicemandatory
- This method must be implemented. CyclicEventQuery getCyclicEventQueryFromInspector(CyclicEventQueryInspector cyclicEventQueryInspector)
CyclicEventSearchResults.
cyclicEventQueryInspector
- a cyclic event query inspectorNullArgumentException
-
cyclicEventQueryInspector
is null
UnsupportedException
- cyclicEventQueryInspector
is not of this servicemandatory
- This method must be implemented.