Interface | osid.personnel.AppointmentLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving appointments. This lookup session defines several views:
The methods | ||
Method | getRealmId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Realm Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getRealm | ||
Description |
Gets the | ||
Return | osid.personnel.Realm | the realm | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupAppointments | ||
Description |
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 | ||
Return | boolean | false if realm reading methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeAppointmentView | ||
Description |
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. | |
Method | usePlenaryAppointmentView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedRealmView | ||
Description |
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. | |
Method | useIsolatedRealmView | ||
Description |
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. | |
Method | useEffectiveAppointmentView | ||
Description |
Only appointments whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveAppointmentView | ||
Description |
All appointments of any effective dates are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAppointment | ||
Description |
Gets the In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned. | ||
Parameters | osid.id.Id | appointmentId | the Id of the Appointment to retrieve |
Return | osid.personnel.Appointment | the returned Appointment | |
Errors | NOT_FOUND | no Appointment found with the given Id | |
NULL_ARGUMENT | appointmentId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentsByIds | ||
Description |
Gets an In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned. | ||
Parameters | osid.id.IdList | appointmentIds | the list of Ids to retrieve |
Return | osid.personnel.AppointmentList | the returned Appointment list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | appointmentIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentsByGenusType | ||
Description |
Gets an In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned. | ||
Parameters | osid.type.Type | appointmentGenusType | an appointments genus type |
Return | osid.personnel.AppointmentList | the returned Appointment list | |
Errors | NULL_ARGUMENT | appointmentGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentsByParentGenusType | ||
Description |
Gets an In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned. | ||
Parameters | osid.type.Type | appointmentGenusType | an appointment genus type |
Return | osid.personnel.AppointmentList | the returned Appointment list | |
Errors | NULL_ARGUMENT | appointmentGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentsByRecordType | ||
Description |
Gets an 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 | osid.type.Type | appointmentRecordType | an appointment record type |
Return | osid.personnel.AppointmentList | the returned AppointmentList | |
Errors | NULL_ARGUMENT | appointmentRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentsOnDate | ||
Description |
Gets an 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 | osid.calendaring.DateTime | from | start of date range |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.personnel.AppointmentList | the returned AppointmentList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentsForPerson | ||
Description |
Gets an In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned. | ||
Parameters | osid.id.Id | personId | the Id of the person |
Return | osid.personnel.AppointmentList | the returned AppointmentList | |
Errors | NULL_ARGUMENT | personId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentsForPersonOnDate | ||
Description |
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 | osid.id.Id | personId | a person Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.personnel.AppointmentList | the returned AppointmentList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | personId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentsForPosition | ||
Description |
Gets an In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned. | ||
Parameters | osid.id.Id | positionId | a position Id |
Return | osid.personnel.AppointmentList | the returned AppointmentList | |
Errors | NULL_ARGUMENT | positionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentsForPositionOnDate | ||
Description |
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 | osid.id.Id | positionId | a position Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.personnel.AppointmentList | the returned AppointmentList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | positionId, from, or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentsForPersonAndPosition | ||
Description |
Gets an In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned. | ||
Parameters | osid.id.Id | personId | a person Id |
osid.id.Id | positionId | a position Id | |
Return | osid.personnel.AppointmentList | the returned AppointmentList | |
Errors | NULL_ARGUMENT | personId or positionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAppointmentsForPersonAndPositionOnDate | ||
Description |
Gets an 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 In effective mode, appointments are returned that are currently effective. In any effective mode, effective appointments and those currently expired are returned. | ||
Parameters | osid.id.Id | personId | a person Id |
osid.id.Id | positionId | a position Id | |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.personnel.AppointmentList | the returned AppointmentList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | referenceId, resourceId, from, or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAppointments | ||
Description |
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. | ||
Return | osid.personnel.AppointmentList | a list of appointments | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |