Interface AppointmentLookupSession

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

This session defines methods for retrieving appointments.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated realm view: All appointment methods in this session operate, retrieve and pertain to appointments defined explicitly in the current realm. Using an isolated view is useful for managing appointments with the AppointmentAdminSession .
  • federated realm view: All appointment lookup methods in this session operate, retrieve and pertain to all appointments defined in this realm and any other realms implicitly available in this realm through realm inheritence.
  • effective appointment view: All appointment lookup methods return appointments where the current date falls in between the effective dates inclusive.
  • any effective appointment view: Appointments of any effective date are returned from methods.

The methods useFederatedRealmView() and useIsolatedRealmView() behave as a radio group and one should be selected before invoking any lookup methods.

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

    • canLookupAppointments

      boolean canLookupAppointments()
      Tests if this user can examine this realm. 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 these operations.
      Returns:
      false if realm reading methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeAppointmentView

      void useComparativeAppointmentView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryAppointmentView

      void usePlenaryAppointmentView()
      A complete view of the Appointment returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is 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 retrievals to this realm only.
      Compliance:
      mandatory - This method is must be implemented.

    • useEffectiveAppointmentView

      void useEffectiveAppointmentView()
      Only appointments whose effective dates are current are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyEffectiveAppointmentView

      void useAnyEffectiveAppointmentView()
      All appointments of any effective dates are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getAppointment

      Appointment getAppointment(Id appointmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Appointment specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Appointment may have a different Id than requested, such as the case where a duplicate Id was assigned to an Appointment and retained for compatibility. In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned.
      Parameters:
      appointmentId - the Id of the Appointment to retrieve
      Returns:
      the returned Appointment
      Throws:
      NotFoundException - no Appointment found with the given Id
      NullArgumentException - appointmentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentsByIds

      AppointmentList getAppointmentsByIds(IdList appointmentIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an AppointmentList corresponding to the given IdList . In plenary mode, the returned list contains all of the appointments specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible appointments may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned.
      Parameters:
      appointmentIds - the list of Ids to retrieve
      Returns:
      the returned Appointment list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - appointmentIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentsByGenusType

      AppointmentList getAppointmentsByGenusType(Type appointmentGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an AppointmentList corresponding to the given appointment genus Type which does not include appointments of types derived from the specified Type . In plenary mode, the returned list contains all known appointments or an error results. Otherwise, the returned list may contain only those appointments that are accessible through this session. In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned.
      Parameters:
      appointmentGenusType - an appointments genus type
      Returns:
      the returned Appointment list
      Throws:
      NullArgumentException - appointmentGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentsByParentGenusType

      AppointmentList getAppointmentsByParentGenusType(Type appointmentGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an AppointmentList corresponding to the given appointment genus Type and include any additional appointments with genus types derived from the specified Type . In plenary mode, the returned list contains all known appointments or an error results. Otherwise, the returned list may contain only those appointments that are accessible through this session. In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned.
      Parameters:
      appointmentGenusType - an appointment genus type
      Returns:
      the returned Appointment list
      Throws:
      NullArgumentException - appointmentGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentsByRecordType

      AppointmentList getAppointmentsByRecordType(Type appointmentRecordType) throws OperationFailedException, PermissionDeniedException
      Gets an AppointmentList containing the given appointment record Type . In plenary mode, the returned list contains all known appointments or an error results. Otherwise, the returned list may contain only those appointments that are accessible through this session. In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned.
      Parameters:
      appointmentRecordType - an appointment record type
      Returns:
      the returned AppointmentList
      Throws:
      NullArgumentException - appointmentRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentsOnDate

      AppointmentList getAppointmentsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an AppointmentList effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known appointments or an error results. Otherwise, the returned list may contain only those appointments that are accessible through this session. In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned.
      Parameters:
      from - start of date range
      to - end of date range
      Returns:
      the returned AppointmentList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentsForPerson

      AppointmentList getAppointmentsForPerson(Id personId) throws OperationFailedException, PermissionDeniedException
      Gets an AppointmentList for the given person Id . In plenary mode, the returned list contains all of the appointments corresponding to the given person, including duplicates, or an error results if an appointment is inaccessible. Otherwise, inaccessible Appointments may be omitted from the list. In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned.
      Parameters:
      personId - the Id of the person
      Returns:
      the returned AppointmentList
      Throws:
      NullArgumentException - personId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentsForPersonOnDate

      AppointmentList getAppointmentsForPersonOnDate(Id personId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of appointments for a resource and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known appointments or an error results. Otherwise, the returned list may contain only those appointments that are accessible through this session. In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned.
      Parameters:
      personId - a person Id
      from - start of date range
      to - end of date range
      Returns:
      the returned AppointmentList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - personId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentsForPosition

      AppointmentList getAppointmentsForPosition(Id positionId) throws OperationFailedException, PermissionDeniedException
      Gets an AppointmentList for the given position. Id . In plenary mode, the returned list contains all of the appointments corresponding to the given position, including duplicates, or an error results if an appointment is inaccessible. Otherwise, inaccessible Appointments may be omitted from the list. In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned.
      Parameters:
      positionId - a position Id
      Returns:
      the returned AppointmentList
      Throws:
      NullArgumentException - positionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentsForPositionOnDate

      AppointmentList getAppointmentsForPositionOnDate(Id positionId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of appointments for a position and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known appointments or an error results. Otherwise, the returned list may contain only those appointments that are accessible through this session. In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned.
      Parameters:
      positionId - a position Id
      from - start of date range
      to - end of date range
      Returns:
      the returned AppointmentList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - positionId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentsForPersonAndPosition

      AppointmentList getAppointmentsForPersonAndPosition(Id personId, Id positionId) throws OperationFailedException, PermissionDeniedException
      Gets an AppointmentList for the given person and position. In plenary mode, the returned list contains all of the appointments corresponding to the given resource and reference, including duplicates, or an error results if an appointment is inaccessible. Otherwise, inaccessible Appointments may be omitted from the list. In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned.
      Parameters:
      personId - a person Id
      positionId - a position Id
      Returns:
      the returned AppointmentList
      Throws:
      NullArgumentException - personId or positionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentsForPersonAndPositionOnDate

      AppointmentList getAppointmentsForPersonAndPositionOnDate(Id personId, Id positionId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an AppointmentList corresponding to the given person and position and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all of the appointments corresponding to the given peer, including duplicates, or an error results if an appointment is inaccessible. Otherwise, inaccessible Appointments may be omitted from the list. In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned.
      Parameters:
      personId - a person Id
      positionId - a position Id
      from - start of date range
      to - end of date range
      Returns:
      the returned AppointmentList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - referenceId, resourceId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAppointments

      AppointmentList getAppointments() throws OperationFailedException, PermissionDeniedException
      Gets all appointments. In plenary mode, the returned list contains all known appointments or an error results. Otherwise, the returned list may contain only those appointments that are accessible through this session. In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned.
      Returns:
      a list of appointments
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.