Interface CyclicTimePeriodSearchSession

All Superinterfaces:

AutoCloseable, Closeable, CyclicTimePeriodQuerySession, OsidSession, OsidSession

public interface CyclicTimePeriodSearchSession
extends CyclicTimePeriodQuerySession

This session provides methods for searching CyclicTimePeriods. 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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface CyclicTimePeriodQuerySession

canSearchCyclicTimePeriods, getCalendar, getCalendarId, getCyclicTimePeriodQuery, getCyclicTimePeriodsByQuery, useFederatedCalendarView, useIsolatedCalendarView

Modifier and Type	Method	Description
boolean	canSearchCyclicTimePeriods()	Tests if this user can perform CyclicTimePeriod searches.
Calendar	getCalendar()	Gets the Calendar associated with this session.
Id	getCalendarId()	Gets the Calendar Id associated with this session.
CyclicTimePeriodQuery	getCyclicTimePeriodQuery()	Gets a cyclic time period query.
CyclicTimePeriodList	getCyclicTimePeriodsByQuery(CyclicTimePeriodQuery cyclicTimePeriodQuery)	Gets a list of CyclicTimePeriods matching the given query.
void	useFederatedCalendarView()	Federates the view for methods in this session.
void	useIsolatedCalendarView()	Isolates the view for methods in this session.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getCyclicTimePeriodSearch

CyclicTimePeriodSearch getCyclicTimePeriodSearch()

Gets a cyclic time period search.

Returns:

the cyclic time period search

Compliance:

mandatory - This method must be implemented.

getCyclicTimePeriodSearchOrder

CyclicTimePeriodSearchOrder getCyclicTimePeriodSearchOrder()

Gets a cyclic time period search order. The CyclicTimePeriodSearchOrder is supplied to a CyclicTimePeriodSearch to specify the ordering of results.

Returns:

the cyclic time period search order

Compliance:

mandatory - This method must be implemented.

getCyclicTimePeriodsBySearch

CyclicTimePeriodSearchResults getCyclicTimePeriodsBySearch(CyclicTimePeriodQuery cyclicTimePeriodQuery,
 CyclicTimePeriodSearch cyclicTimePeriodSearch)
                                                    throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

cyclicTimePeriodQuery - the cyclic time period query

cyclicTimePeriodSearch - the cyclic time period search

Returns:

the cyclic time period search results

Throws:

NullArgumentException - cyclicTimePeriodQuery or cyclicTimePeriodSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - cyclicTimePeriodSearch or t imePeriodQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getCyclicTimePeriodQueryFromInspector

CyclicTimePeriodQuery getCyclicTimePeriodQueryFromInspector(CyclicTimePeriodQueryInspector cyclicTimePeriodQueryInspector)

Gets a cyclic time period query from an inspector. The inspector is available from a CyclicTimePeriodSearchResults.

Parameters:

cyclicTimePeriodQueryInspector - a cyclic time period query inspector

Returns:

the cyclic time period query

Throws:

NullArgumentException - cyclicTimePeriodQueryInspector is null

UnsupportedException - cyclicTimePeriodQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.