Interface CyclicEventSearchSession

All Superinterfaces:

AutoCloseable, Closeable, CyclicEventQuerySession, OsidSession, OsidSession

public interface CyclicEventSearchSession
extends CyclicEventQuerySession

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

• federated calendar view: searches include cyclic events in calendars of which this calendar is an ancestor in the calendar hierarchy
• isolated calendar view: searches are restricted to cyclic events in this calendar

Cyclic events may have a query record indicated by their respective record types. The query record is accessed via the CyclicEventQuery.

Method Summary

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

Methods inherited from interface Closeable

close

Methods inherited from interface CyclicEventQuerySession

canSearchCyclicEvents, getCalendar, getCalendarId, getCyclicEventQuery, getCyclicEventsByQuery, useFederatedCalendarView, useIsolatedCalendarView

Modifier and Type	Method	Description
boolean	canSearchCyclicEvents()	Tests if this user can perform CyclicEvent searches.
Calendar	getCalendar()	Gets the Calendar associated with this session.
Id	getCalendarId()	Gets the Calendar Id associated with this session.
CyclicEventQuery	getCyclicEventQuery()	Gets a cyclic event query.
CyclicEventList	getCyclicEventsByQuery(CyclicEventQuery cyclicEventQuery)	Gets a list of CyclicEvents matching the given cyclic event 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

getCyclicEventSearch

CyclicEventSearch getCyclicEventSearch()

Gets a cyclic event search.

Returns:

the cyclic event search

Compliance:

mandatory - This method must be implemented.

getCyclicEventSearchOrder

CyclicEventSearchOrder getCyclicEventSearchOrder()

Gets a cyclic event search order. The CyclicEventSearchOrder is supplied to a CyclicEventSearch to specify the ordering of results.

Returns:

the cyclic event search order

Compliance:

mandatory - This method must be implemented.

getCyclicEventsBySearch

CyclicEventSearchResults getCyclicEventsBySearch(CyclicEventQuery cyclicEventQuery,
 CyclicEventSearch cyclicEventSearch)
                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

cyclicEventQuery - the cyclic event search query

cyclicEventSearch - the cyclic event search

Returns:

the cyclic event search results

Throws:

NullArgumentException - cyclicEventQuery or cyclicEventSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - cyclicEventSearch or cyclicEventQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getCyclicEventQueryFromInspector

CyclicEventQuery getCyclicEventQueryFromInspector(CyclicEventQueryInspector cyclicEventQueryInspector)

Gets a cyclic event query from an inspector. The inspector is available from a CyclicEventSearchResults.

Parameters:

cyclicEventQueryInspector - a cyclic event query inspector

Returns:

the cyclic event query

Throws:

NullArgumentException - cyclicEventQueryInspector is null

UnsupportedException - cyclicEventQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.