org.osid.calendaring

Interface EventSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, EventQuerySession, 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 a 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

Methods

Modifier and Type	Method and 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 org.osid.calendaring.EventQuerySession

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.