OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.TimePeriodNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive asynchronous notifications on adds/changes to TimePeriods. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

The two views defined in this session correspond to the views in the TimePeriodLookupSession.

MethodgetCalendarId
Description

Gets the Calendar Id associated with this session.

Returnosid.id.Idthe Calendar Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCalendar
Description

Gets the Calendar associated with this session.

Returnosid.calendaring.Calendarthe Calendar associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForTimePeriodNotifications
Description

Tests if this user can register for TimePeriod notifications. 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 notification operations.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCalendarView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCalendarView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this calendar only.

CompliancemandatoryThis method is must be implemented.
MethodreliableTimePeriodNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeTimePeriodNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableTimePeriodNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeTimePeriodNotification
Description

Acknowledge a time period notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewTimePeriods
Description

Register for notifications of new time periods. TimePeriodReceiver.newTimePeriods() is invoked when a new time period is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedTimePeriods
Description

Registers for notification of updated time periods. TimePeriodReceiver.changedTimePeriods() is invoked when a time period is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedTimePeriod
Description

Registers for notification of an updated time period. TimePeriodReceiver.changedTimePeriods() is invoked when the specified time period is changed.

Parametersosid.id.IdtimePeriodIdthe Id of the TimePeriod to monitor
ErrorsNULL_ARGUMENT timePeriodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedTimePeriods
Description

Registers for notification of deleted time periods. TimePeriodReceiver.deletedTimePeriods() is invoked when a time period is removed from this calendar.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedTimePeriod
Description

Registers for notification of a deleted time period. TimePeriodReceiver.changedTimePeriods() is invoked when the specified time period is removed from this calendar.

Parametersosid.id.IdtimePeriodIdthe Id of the TimePeriod to monitor
ErrorsNULL_ARGUMENT timePeriodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.