org.osid.calendaring

Interface OffsetEventSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OffsetEventQuerySession, OsidSession

public interface OffsetEventSearchSession
extends OffsetEventQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
OffsetEventQuery	getOffsetEventQueryFromInspector(OffsetEventQueryInspector offsetEventQueryInspector) Gets an offset event query from an inspector.
OffsetEventSearchResults	getOffsetEventsBySearch(OffsetEventQuery offsetEventQuery, OffsetEventSearch offsetEventSearch) Gets the search results matching the given search query using the given search.
OffsetEventSearch	getOffsetEventSearch() Gets an offset event search.
OffsetEventSearchOrder	getOffsetEventSearchOrder() Gets an offset event search order.

Methods inherited from interface org.osid.calendaring.OffsetEventQuerySession

canSearchOffsetEvents, getCalendar, getCalendarId, getOffsetEventQuery, getOffsetEventsByQuery, useFederatedCalendarView, useIsolatedCalendarView

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

getOffsetEventSearch

OffsetEventSearch getOffsetEventSearch()

Gets an offset event search.

Returns:

the offset event search

Compliance:

mandatory - This method must be implemented.

getOffsetEventSearchOrder

OffsetEventSearchOrder getOffsetEventSearchOrder()

Gets an offset event search order. The OffsetEventSearchOrder is supplied to an OffsetEventSearch to specify the ordering of results.

Returns:

the offset event search order

Compliance:

mandatory - This method must be implemented.

getOffsetEventsBySearch

OffsetEventSearchResults getOffsetEventsBySearch(OffsetEventQuery offsetEventQuery,
                                               OffsetEventSearch offsetEventSearch)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

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

Parameters:

offsetEventQuery - the offset event search query

offsetEventSearch - the offset event search

Returns:

the returned search results

Throws:

NullArgumentException - offsetEventQuery or offsetEventSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - offsetEventQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getOffsetEventQueryFromInspector

OffsetEventQuery getOffsetEventQueryFromInspector(OffsetEventQueryInspector offsetEventQueryInspector)

Gets an offset event query from an inspector. The inspector is available from an OffsetEventSearchResults.

Parameters:

offsetEventQueryInspector - an offset event query inspector

Returns:

the offset event query

Throws:

NullArgumentException - offsetEventQueryInspector is null

UnsupportedException - offsetEventQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.