Interface ScheduleQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ScheduleSearchSession
public interface ScheduleQuerySession extends OsidSession

This session provides methods for searching Schedule objects. The search query is constructed using the ScheduleQuery. The schedule record Type also specifies the record for the schedule query.

This session defines views that offer differing behaviors for searching.

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

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

  • 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 associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchSchedules

      boolean canSearchSchedules()
      Tests if this user can perform Schedules searches. 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 opt not to offer search 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 schedules in calendars which are children of this calendar 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 searches to this calendar only.
      Compliance:
      mandatory - This method is must be implemented.

    • getScheduleQuery

      ScheduleQuery getScheduleQuery()
      Gets a schedule query.
      Returns:
      the schedule query
      Compliance:
      mandatory - This method must be implemented.

    • getSchedulesByQuery

      ScheduleList getSchedulesByQuery(ScheduleQuery scheduleQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Schedules matching the given schedle query.
      Parameters:
      scheduleQuery - the schedule query
      Returns:
      the returned ScheduleList
      Throws:
      NullArgumentException - scheduleQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - scheduleQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.