Interface TimePeriodQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
TimePeriodSearchSession
public interface TimePeriodQuerySession extends OsidSession

This session provides methods for searching TimePeriod objects. The search query is constructed using the TimePeriodQuery . The time period record Type also specifies the record for the time period query.

Time periods may have a query record indicated by their respective record types. The query record is accessed via the TimePeriodQuery .

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

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

    • canSearchTimePeriods

      boolean canSearchTimePeriods()
      Tests if this user can perform TimePeriod 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 time periods in calendars which are children of this calendar in the calendar hierarchy.
      Compliance:
      mandatory - This method 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 must be implemented.

    • getTimePeriodQuery

      TimePeriodQuery getTimePeriodQuery()
      Gets a time period query.
      Returns:
      the time period query
      Compliance:
      mandatory - This method must be implemented.

    • getTimePeriodsByQuery

      TimePeriodList getTimePeriodsByQuery(TimePeriodQuery timePeriodQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of TimePeriods matching the given query.
      Parameters:
      timePeriodQuery - the time period query
      Returns:
      the returned TimePeriodList
      Throws:
      NullArgumentException - timePeriodQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - timePeriodQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.