Interface CyclicTimePeriodQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
CyclicTimePeriodSearchSession
public interface CyclicTimePeriodQuerySession extends OsidSession

This session provides methods for searching CyclicTimePeriods. The search query is constructed using the CyclicTimePeriodQuery. The cyclic time period record Type also specifies the record for the cyclic time period query.

Cyclic time periods may have a query record indicated by their respective record types. The query record is accessed via the CyclicTimePeriodQuery.

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

    • canSearchCyclicTimePeriods

      boolean canSearchCyclicTimePeriods()
      Tests if this user can perform CyclicTimePeriod 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 cyclic time periods 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.

    • getCyclicTimePeriodQuery

      CyclicTimePeriodQuery getCyclicTimePeriodQuery()
      Gets a cyclic time period query.
      Returns:
      the cyclic time period query
      Compliance:
      mandatory - This method must be implemented.

    • getCyclicTimePeriodsByQuery

      CyclicTimePeriodList getCyclicTimePeriodsByQuery(CyclicTimePeriodQuery cyclicTimePeriodQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of CyclicTimePeriods matching the given query.
      Parameters:
      cyclicTimePeriodQuery - the cyclic time period query
      Returns:
      the returned CyclicTimePeriodList
      Throws:
      NullArgumentException - cyclicTimePeriodQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - cyclicTimePeriodQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.