Interface AppointmentSmartRealmSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface AppointmentSmartRealmSession extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. An AppointmentQuery can be retrieved from this session and mapped to this Realm to create a virtual collection of Appointments . The appointments may be sequenced using the AppointmentSearchOrder from this session.

This Realm has a default query that matches any appointment and a default search order that specifies no sequencing. The queries may be examined using an AppointmentQueryInspector . The query may be modified by converting the inspector back to an AppointmentQuery .

  • Method Details

    • getRealmId

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

    • getRealm

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

    • canManageSmartRealms

      boolean canManageSmartRealms()
      Tests if this user can manage smart realms. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
      Returns:
      false if smart realm management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentQuery

      AppointmentQuery getAppointmentQuery()
      Gets an appointment query.
      Returns:
      the appointment query
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentSearchOrder

      AppointmentSearchOrder getAppointmentSearchOrder()
      Gets an appointment search order.
      Returns:
      the appointment search order
      Compliance:
      mandatory - This method must be implemented.

    • applyAppointmentQuery

      void applyAppointmentQuery(AppointmentQuery appointmentQuery) throws OperationFailedException, PermissionDeniedException
      Applies an appointment query to this realm.
      Parameters:
      appointmentQuery - the appointment query
      Throws:
      NullArgumentException - appointmentQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - appointmentQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectAppointmentQuery

      AppointmentQueryInspector inspectAppointmentQuery() throws OperationFailedException, PermissionDeniedException
      Gets an appointment query inspector for this realm.
      Returns:
      the appointment query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyAppointmentSequencing

      void applyAppointmentSequencing(AppointmentSearchOrder appointmentSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies an appointment search order to this realm.
      Parameters:
      appointmentSearchOrder - the appointment search order
      Throws:
      NullArgumentException - appointmentSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - appointmentSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentQueryFromInspector

      AppointmentQuery getAppointmentQueryFromInspector(AppointmentQueryInspector appointmentQueryInspector)
      Gets an appointment query from an inspector.
      Parameters:
      appointmentQueryInspector - a query inspector
      Returns:
      the appointment query
      Throws:
      NullArgumentException - appointmentQueryInspector is null
      UnsupportedException - appointmentQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.