Interface EventSearchSession

All Superinterfaces:

AutoCloseable, Closeable, EventQuerySession, OsidSession, OsidSession

public interface EventSearchSession
extends EventQuerySession

This session provides methods for searching Event objects. The search query is constructed using the EventQuery . The event record Type also specifies the record for the event query.

getEventsByQuery() is the basic search method and returns a list of Events . A more advanced search may be performed with getEventsBySearch() . It accepts an EventSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getEventsBySearch() returns an EventSearchResults that can be used to access the resulting EventList or be used to perform a search within the result set through EventSearch .

This session defines views that offer differing behaviors for searching.

• federated calendar view: searches include events in calendars of which this calendar is an ancestor in the calendar hierarchy
• isolated calendar view: searches are restricted to events in this calendar
• denormalized event view: recurring events are expanded into a series of non-recurring events
• normalized event view: a series of recurring events is represented by a single Event

Events may have a query record indicated by their respective record types. The query record is accessed via the EventQuery .

Method Summary

Modifier and Type	Method	Description
EventQuery	getEventQueryFromInspector(EventQueryInspector eventQueryInspector)	Gets an event query from an inspector.
EventSearchResults	getEventsBySearch(EventQuery eventQuery, EventSearch eventSearch)	Gets the search results matching the given search query using the given search.
EventSearch	getEventSearch()	Gets an event search.
EventSearchOrder	getEventSearchOrder()	Gets an event search order.

Methods inherited from interface Closeable

close

Methods inherited from interface EventQuerySession

canSearchEvents, getCalendar, getCalendarId, getEventQuery, getEventsByQuery, useDenormalizedEventView, useFederatedCalendarView, useIsolatedCalendarView, useNormalizedEventView, useSequesteredEventView, useUnsequesteredEventView

Modifier and Type	Method	Description
boolean	canSearchEvents()	Tests if this user can perform Events searches.
Calendar	getCalendar()	Gets the Calendar associated with this session.
Id	getCalendarId()	Gets the Calendar Id associated with this session.
EventQuery	getEventQuery()	Gets an event query.
EventList	getEventsByQuery(EventQuery eventQuery)	Gets a list of Events matching the given event query.
void	useDenormalizedEventView()	A denormalized view expands recurring events into a series of Events .
void	useFederatedCalendarView()	Federates the view for methods in this session.
void	useIsolatedCalendarView()	Isolates the view for methods in this session.
void	useNormalizedEventView()	A normalized view uses a single Event to represent a set of recurring events.
void	useSequesteredEventView()	The returns from the search methods omit sequestered events.
void	useUnsequesteredEventView()	All replies are returned including sequestered events.

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

getEventSearch

EventSearch getEventSearch()

Gets an event search.

Returns:

the event search

Compliance:

mandatory - This method must be implemented.

getEventSearchOrder

EventSearchOrder getEventSearchOrder()

Gets an event search order. The EventSearchOrder is supplied to an EventSearch to specify the ordering of results.

Returns:

the event search order

Compliance:

mandatory - This method must be implemented.

getEventsBySearch

EventSearchResults getEventsBySearch(EventQuery eventQuery,
 EventSearch eventSearch)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

eventQuery - the event search query

eventSearch - the event search

Returns:

the event search results

Throws:

NullArgumentException - eventQuery or eventSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - eventSearch or eventQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getEventQueryFromInspector

EventQuery getEventQueryFromInspector(EventQueryInspector eventQueryInspector)

Gets an event query from an inspector. The inspector is available from an EventSearchResults .

Parameters:

eventQueryInspector - an event query inspector

Returns:

the event query

Throws:

NullArgumentException - eventQueryInspector is null

UnsupportedException - eventQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.