Interface OffsetEventEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
OffsetEventEnablerSearchSession
public interface OffsetEventEnablerQuerySession extends OsidSession

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

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

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

  • 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.

    • canSearchOffsetEventEnablers

      boolean canSearchOffsetEventEnablers()
      Tests if this user can perform OffsetEventEnabler 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 offset 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.

    • getOffsetEventEnablerQuery

      OffsetEventEnablerQuery getOffsetEventEnablerQuery()
      Gets an offset event enabler query.
      Returns:
      the offset event enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getOffsetEventEnablersByQuery

      OffsetEventEnablerList getOffsetEventEnablersByQuery(OffsetEventEnablerQuery offsetEventEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of OffsetEventEnablers matching the given offset event enabler query.
      Parameters:
      offsetEventEnablerQuery - the offset event enabler query
      Returns:
      the returned OffsetEventEnablerList
      Throws:
      NullArgumentException - offsetEventEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - offsetEventEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.