Interface | osid.calendaring.TimePeriodNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive asynchronous
notifications on adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getCalendarId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Calendar Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCalendar | ||
Description |
Gets the | ||
Return | osid.calendaring.Calendar | the Calendar associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForTimePeriodNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedCalendarView | ||
Description |
Federates the view for methods in this session. A federated view will include notifications for time periods in calendars which are children of this calendar in the calendar hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCalendarView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this calendar only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableTimePeriodNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableTimePeriodNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeTimePeriodNotification | ||
Description |
Acknowledge a time period notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewTimePeriods | ||
Description |
Register for notifications of new time periods. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedTimePeriods | ||
Description |
Registers for notification of updated time periods.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedTimePeriod | ||
Description |
Registers for notification of an updated time period.
| ||
Parameters | osid.id.Id | timePeriodId | the Id of the TimePeriod to monitor |
Errors | NULL_ARGUMENT | timePeriodId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedTimePeriods | ||
Description |
Registers for notification of deleted time periods.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedTimePeriod | ||
Description |
Registers for notification of a deleted time period.
| ||
Parameters | osid.id.Id | timePeriodId | the Id of the TimePeriod to monitor |
Errors | NULL_ARGUMENT | timePeriodId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |