Interface RecurringEventSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RecurringEventQuerySession
public interface RecurringEventSearchSession extends RecurringEventQuerySession

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

getRecurringEventsByQuery() is the basic search method and returns a list of RecurringEvents. A more advanced search may be performed with geRecurringEventsBySearch(). It accepts a RecurringEventSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRecurringEventsBySearch() returns a RecurringEventSearchResults that can be used to access the resulting RecurringEventList or be used to perform a search within the result set through RecurringEventSearch.

This session defines views that offer differing behaviors for searching.

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

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

Like all OsidSessions, RecurringEventSearchSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getRecurringEventSearch

      RecurringEventSearch getRecurringEventSearch()
      Gets a recurring event search.
      Returns:
      the recurring event search
      Compliance:
      mandatory - This method must be implemented.

    • getRecurringEventSearchOrder

      RecurringEventSearchOrder getRecurringEventSearchOrder()
      Gets a recurring event search order. The RecurringEventSearchOrder is supplied to a RecurringEventSearch to specify the ordering of results.
      Returns:
      the recurring event search order
      Compliance:
      mandatory - This method must be implemented.

    • getRecurringEventsBySearch

      RecurringEventSearchResults getRecurringEventsBySearch(RecurringEventQuery recurringEventQuery, RecurringEventSearch recurringEventSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      recurringEventQuery - the recurring event search query
      recurringEventSearch - the recurring event search
      Returns:
      the recurring event search results
      Throws:
      NullArgumentException - recurringEventQuery or recurringEventSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - recurringEventSearch or recurringEventQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getRecurringEventQueryFromInspector

      RecurringEventQuery getRecurringEventQueryFromInspector(RecurringEventQueryInspector recurringEventQueryInspector)
      Gets a recurring event query from an inspector. The inspector is available from a RecurringEventSearchResults.
      Parameters:
      recurringEventQueryInspector - a recurring event query inspector
      Returns:
      the recurring event query
      Throws:
      NullArgumentException - recurringEventQueryInspector is null
      UnsupportedException - recurringEventQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.