Interface SupersedingEventEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
SupersedingEventEnablerSearchSession
public interface SupersedingEventEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

superseding event enablers may have a query record indicated by their respective record types. The query record is accessed via the SupersedingEventEnablerQuery.

  • Method Details

    • getCalendarId

      Id getCalendarId()
      Gets the Calendar Id associated with this session.
      Returns:
      the Calendar Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getCalendar

      Calendar getCalendar() throws OperationFailedException, PermissionDeniedException
      Gets the Calendar associated with this session.
      Returns:
      the calendar
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchSupersedingEventEnablers

      boolean canSearchSupersedingEventEnablers()
      Tests if this user can perform SupersedingEventEnabler lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedCalendarView

      void useFederatedCalendarView()
      Federates the view for methods in this session. A federated view will include superseding event enablers in calendars which are children of this broker in the calendar hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCalendarView

      void useIsolatedCalendarView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this calendar only.
      Compliance:
      mandatory - This method is must be implemented.

    • getSupersedingEventEnablerQuery

      SupersedingEventEnablerQuery getSupersedingEventEnablerQuery()
      Gets a superseding event enabler query.
      Returns:
      the superseding event enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingEventEnablersByQuery

      SupersedingEventEnablerList getSupersedingEventEnablersByQuery(SupersedingEventEnablerQuery supersedingEventEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of SupersedingEventEnablers matching the given superseding event enabler query.
      Parameters:
      supersedingEventEnablerQuery - the superseding event enabler query
      Returns:
      the returned SupersedingEventEnablerList
      Throws:
      NullArgumentException - supersedingEventEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - supersedingEventEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.