Interface AppointmentQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
AppointmentSearchSession
public interface AppointmentQuerySession extends OsidSession

This session provides methods for querying Appointment objects. The search query is constructed using the AppointmentQuery.

This session defines views that offer differing behaviors for searching.

  • federated realm view: searches include appointments in realms of which this realm is an ancestor in the realm hierarchy
  • isolated realm view: searches are restricted to appointments in this realm

Appointments may have a query record indicated by their respective record types. The query record is accessed via the AppointmentQuery. The returns in this session may not be cast directly to these interfaces.

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

    • canSearchAppointments

      boolean canSearchAppointments()
      Tests if this user can perform Appointment 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 wish 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.

    • useFederatedRealmView

      void useFederatedRealmView()
      Federates the view for methods in this session. A federated view will include appointments in realms which are children of this realm in the realm hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedRealmView

      void useIsolatedRealmView()
      Isolates the view for methods in this session. An isolated view restricts searches to this realm only.
      Compliance:
      mandatory - This method is must be implemented.

    • getAppointmentQuery

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

    • getAppointmentsByQuery

      AppointmentList getAppointmentsByQuery(AppointmentQuery appointmentQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of appointments matching the given appointment query.
      Parameters:
      appointmentQuery - the appointment query
      Returns:
      the returned AppointmentList
      Throws:
      NullArgumentException - appointmentQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - appointmentQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.