public interface CyclicTimePeriodSearchSession extends CyclicTimePeriodQuerySession
This session provides methods for searching CyclicTimePeriod
objects. The search query is constructed using the
CyclicTimePeriodQuery.
The cyclic time period record Type
also specifies the record for the cyclic time period query.
getCyclicTimePeriodsByQuery()
is the basic search
method and returns a list of CyclicTimePeriods.
A more
advanced search may be performed with
getCyclicTimePeriodsBySearch().
It accepts a
CyclicTimePeriodSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getCyclicTimePeriodsBySearch()
returns a
CyclicTimePeriodSearchResults
that can be used to access the
resulting CyclicTimePeriodList
or be used to perform a
search within the result set through CyclicTimePeriodSearch.
Cyclic time periods may have a query record indicated by their
respective record types. The query record is accessed via the
CyclicTimePeriodQuery.
Modifier and Type | Method and Description |
---|---|
CyclicTimePeriodQuery |
getCyclicTimePeriodQueryFromInspector(CyclicTimePeriodQueryInspector cyclicTimePeriodQueryInspector)
Gets a cyclic time period query from an inspector.
|
CyclicTimePeriodSearchResults |
getCyclicTimePeriodsBySearch(CyclicTimePeriodQuery cyclicTimePeriodQuery,
CyclicTimePeriodSearch cyclicTimePeriodSearch)
Gets the search results matching the given search query using the
given search.
|
CyclicTimePeriodSearch |
getCyclicTimePeriodSearch()
Gets a cyclic time period search.
|
CyclicTimePeriodSearchOrder |
getCyclicTimePeriodSearchOrder()
Gets a cyclic time period search order.
|
canSearchCyclicTimePeriods, getCalendar, getCalendarId, getCyclicTimePeriodQuery, getCyclicTimePeriodsByQuery, useFederatedCalendarView, useIsolatedCalendarView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CyclicTimePeriodSearch getCyclicTimePeriodSearch()
mandatory
- This method must be implemented. CyclicTimePeriodSearchOrder getCyclicTimePeriodSearchOrder()
CyclicTimePeriodSearchOrder
is supplied to a
CyclicTimePeriodSearch
to specify the ordering of results.mandatory
- This method must be implemented. CyclicTimePeriodSearchResults getCyclicTimePeriodsBySearch(CyclicTimePeriodQuery cyclicTimePeriodQuery, CyclicTimePeriodSearch cyclicTimePeriodSearch) throws OperationFailedException, PermissionDeniedException
cyclicTimePeriodQuery
- the cyclic time period querycyclicTimePeriodSearch
- the cyclic time period searchNullArgumentException
- cyclicTimePeriodQuery
or cyclicTimePeriodSearch
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- cyclicTimePeriodSearch
or t imePeriodQuery
is not of this
servicemandatory
- This method must be implemented. CyclicTimePeriodQuery getCyclicTimePeriodQueryFromInspector(CyclicTimePeriodQueryInspector cyclicTimePeriodQueryInspector)
CyclicTimePeriodSearchResults.
cyclicTimePeriodQueryInspector
- a cyclic time period query
inspectorNullArgumentException
-
cyclicTimePeriodQueryInspector
is null
UnsupportedException
-
cyclicTimePeriodQueryInspector
is not of this servicemandatory
- This method must be implemented.