public interface TimePeriodSearchSession extends TimePeriodQuerySession
This session provides methods for searching TimePeriod
objects. The search query is constructed using the TimePeriodQuery.
The time period record Type
also specifies the
record for the time period query.
getTimePeriodsByQuery()
is the basic search method and
returns a list of TimePeriods.
A more advanced search may
be performed with getTimePeriodsBySearch().
It accepts a
TimePeriodSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getTimePeriodsBySearch()
returns a
TimePeriodSearchResults
that can be used to access the resulting
TimePeriodList
or be used to perform a search within the
result set through TimePeriodSearch.
Time periods may have a query record indicated by their respective
record types. The query record is accessed via the TimePeriodQuery.
Modifier and Type | Method and Description |
---|---|
TimePeriodQuery |
getTimePeriodQueryFromInspector(TimePeriodQueryInspector timePeriodQueryInspector)
Gets a time period query from an inspector.
|
TimePeriodSearchResults |
getTimePeriodsBySearch(TimePeriodQuery timePeriodQuery,
TimePeriodSearch timePeriodSearch)
Gets the search results matching the given search query using the
given search.
|
TimePeriodSearch |
getTimePeriodSearch()
Gets a time period search.
|
TimePeriodSearchOrder |
getTimePeriodSearchOrder()
Gets a time period search order.
|
canSearchTimePeriods, getCalendar, getCalendarId, getTimePeriodQuery, getTimePeriodsByQuery, useFederatedCalendarView, useIsolatedCalendarView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
TimePeriodSearch getTimePeriodSearch()
mandatory
- This method must be implemented. TimePeriodSearchOrder getTimePeriodSearchOrder()
TimePeriodSearchOrder
is supplied to a TimePeriodSearch
to specify
the ordering of results.mandatory
- This method must be implemented. TimePeriodSearchResults getTimePeriodsBySearch(TimePeriodQuery timePeriodQuery, TimePeriodSearch timePeriodSearch) throws OperationFailedException, PermissionDeniedException
timePeriodQuery
- the time period querytimePeriodSearch
- the time period searchNullArgumentException
- timePeriodQuery
or timePeriodSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- timePeriodSearch
or t imePeriodQuery
is not of this servicemandatory
- This method must be implemented. TimePeriodQuery getTimePeriodQueryFromInspector(TimePeriodQueryInspector timePeriodQueryInspector)
TimePeriodSearchResults.
timePeriodQueryInspector
- a time period query inspectorNullArgumentException
- timePeriodQueryInspector
is null
UnsupportedException
- timePeriodQueryInspector
is not of this servicemandatory
- This method must be implemented.