org.osid.calendaring.rules

Interface RecurringEventEnablerSearchSession

All Superinterfaces:

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

public interface RecurringEventEnablerSearchSession
extends RecurringEventEnablerQuerySession

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

getRecurringEventEnablersByQuery() is the basic search method and returns a list of RecurringEventEnablers. A more advanced search may be performed with getRecurringEventEnablerBySearch(). It accepts a RecurringEventEnabler in addition to the query for the purpose of specifying additional options affecting the entire search, such as calendaring. geRecurringEventEnablersBySearch() returns a RecurringEventEnablerSearchResults that can be used to access the resulting RecurringEventEnablerList or be used to perform a search within the result set through RecurringEventEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
RecurringEventEnablerQuery	getRecurringEventEnablerQueryFromInspector(RecurringEventEnablerQueryInspector recurringEventEnablerQueryInspector) Gets a recurring event enabler query from an inspector.
RecurringEventEnablerSearchResults	getRecurringEventEnablersBySearch(RecurringEventEnablerQuery recurringEventEnablerQuery, RecurringEventEnablerSearch recurringEventEnablerSearch) Gets the search results matching the given search query using the given search.
RecurringEventEnablerSearch	getRecurringEventEnablerSearch() Gets a recurring event enabler search.
RecurringEventEnablerSearchOrder	getRecurringEventEnablerSearchOrder() Gets a recurring event enabler search order.

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

canSearchRecurringEventEnablers, getCalendar, getCalendarId, getRecurringEventEnablerQuery, getRecurringEventEnablersByQuery, 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

getRecurringEventEnablerSearch

RecurringEventEnablerSearch getRecurringEventEnablerSearch()

Gets a recurring event enabler search.

Returns:

the recurring event enabler search

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablerSearchOrder

RecurringEventEnablerSearchOrder getRecurringEventEnablerSearchOrder()

Gets a recurring event enabler search order. The RecurringEventEnablerSearchOrder is supplied to a RecurringEventEnablerSearch to specify the ordering of results.

Returns:

the recurring event enabler search order

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablersBySearch

RecurringEventEnablerSearchResults getRecurringEventEnablersBySearch(RecurringEventEnablerQuery recurringEventEnablerQuery,
                                                                   RecurringEventEnablerSearch recurringEventEnablerSearch)
                                                                     throws OperationFailedException,
                                                                            PermissionDeniedException

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

Parameters:

recurringEventEnablerQuery - the recurring event enabler query

recurringEventEnablerSearch - the recurring event enabler search

Returns:

the returned search results

Throws:

NullArgumentException - recurringEventEnablerQuery or recurringEventEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - recurringEventEnablerQuery or recurringEventEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablerQueryFromInspector

RecurringEventEnablerQuery getRecurringEventEnablerQueryFromInspector(RecurringEventEnablerQueryInspector recurringEventEnablerQueryInspector)

Gets a recurring event enabler query from an inspector. The inspector is available from a RecurringEventEnablerSearchResults.

Parameters:

recurringEventEnablerQueryInspector - a recurring event enabler query inspector

Returns:

the recurring event enabler query

Throws:

NullArgumentException - recurringEventEnablerQueryInspector is null

UnsupportedException - recurringEventEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.