org.osid.calendaring.rules

Interface OffsetEventEnablerSearchSession

All Superinterfaces:

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

public interface OffsetEventEnablerSearchSession
extends OffsetEventEnablerQuerySession

This session provides methods for searching among OffsetEventEnabler objects. The search query is constructed using the OffsetEventEnablerQuery.

getOffsetEventEnablersByQuery() is the basic search method and returns a list of OffsetEventEnablers. A more advanced search may be performed with getOffsetEventEnablersBySearch(). It accepts an OffsetEventEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as calendaring. getOffsetEventEnablersBySearch() returns an OffsetEventEnablerSearchResults that can be used to access the resulting OffsetEventEnablerList or be used to perform a search within the result set through OffsetEventEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
OffsetEventEnablerQuery	getOffsetEventEnablerQueryFromInspector(OffsetEventEnablerQueryInspector offsetEventEnablerQueryInspector) Gets an offset event enabler query from an inspector.
OffsetEventEnablerSearchResults	getOffsetEventEnablersBySearch(OffsetEventEnablerQuery offsetEventEnablerQuery, OffsetEventEnablerSearch offsetEventEnablerSearch) Gets the search results matching the given search query using the given search.
OffsetEventEnablerSearch	getOffsetEventEnablerSearch() Gets an offset event enabler search.
OffsetEventEnablerSearchOrder	getOffsetEventEnablerSearchOrder() Gets an offset event enabler search order.

Methods inherited from interface org.osid.calendaring.rules.OffsetEventEnablerQuerySession

canSearchOffsetEventEnablers, getCalendar, getCalendarId, getOffsetEventEnablerQuery, getOffsetEventEnablersByQuery, 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

getOffsetEventEnablerSearch

OffsetEventEnablerSearch getOffsetEventEnablerSearch()

Gets an offset event enabler search.

Returns:

the offset event enabler search

Compliance:

mandatory - This method must be implemented.

getOffsetEventEnablerSearchOrder

OffsetEventEnablerSearchOrder getOffsetEventEnablerSearchOrder()

Gets an offset event enabler search order. The OffsetEventEnablerSearchOrder is supplied to an OffsetEventEnablerSearch to specify the ordering of results.

Returns:

the offset event enabler search order

Compliance:

mandatory - This method must be implemented.

getOffsetEventEnablersBySearch

OffsetEventEnablerSearchResults getOffsetEventEnablersBySearch(OffsetEventEnablerQuery offsetEventEnablerQuery,
                                                             OffsetEventEnablerSearch offsetEventEnablerSearch)
                                                               throws OperationFailedException,
                                                                      PermissionDeniedException

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

Parameters:

offsetEventEnablerQuery - the offset event enabler query

offsetEventEnablerSearch - the offset event enabler search

Returns:

the returned search results

Throws:

NullArgumentException - offsetEventEnablerQuery or offsetEventEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - offsetEventEnablerQuery or offsetEventEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getOffsetEventEnablerQueryFromInspector

OffsetEventEnablerQuery getOffsetEventEnablerQueryFromInspector(OffsetEventEnablerQueryInspector offsetEventEnablerQueryInspector)

Gets an offset event enabler query from an inspector. The inspector is available from an OffsetEventEnablerSearchResults.

Parameters:

offsetEventEnablerQueryInspector - an offset event enabler query inspector

Returns:

the offset event enabler query

Throws:

NullArgumentException - offsetEventEnablerQueryInspector is null

UnsupportedException - offsetEventEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.