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

This session defines methods to receive asynchronous notifications on adds/changes to event commitments. 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 views defined in this session correspond to the views in the CommitmentLookupSession.

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.
MethodcanRegisterForCommitmentNotifications
Description

Tests if this user can register for Commitment 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 commitments 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.
MethodreliableCommitmentNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableCommitmentNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeCommitmentNotification
Description

Acknowledge a commitment notification.

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

Register for notifications of new commitments. CommitmentReceiver.newCommitments() is invoked when a new commitment is created.

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

Register for notifications of new commitments by commitment genus type. CommitmentReceiver.newCommitments() is invoked when a new commitment is created.

Parametersosid.id.IdcommitmentGenusTypethe commitment genus type to monitor
ErrorsNULL_ARGUMENT commitmentGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCommitmentsForEvent
Description

Register for notifications of new commitments for the given event. CommitmentReceiver.newCommitments() is invoked when a new commitment is created.

Parametersosid.id.IdeventIdthe Id of the Event to monitor
ErrorsNULL_ARGUMENT eventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCommitmentsForResource
Description

Register for notifications of new commitments for the given resource. CommitmentReceiver.newCommitments() is invoked when a new commitment is created.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCommitments
Description

Registers for notification of updated commitments. CommitmentReceiver.changedCommitments() is invoked when a commitment is changed.

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

Register for notifications of changed commitments by commitment genus type. CommitmentReceiver.changedCommitments() is invoked when a commitment is changed.

Parametersosid.type.TypecommitmentGenusTypethe commitment genus type to monitor
ErrorsNULL_ARGUMENT commitmentGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCommitmentsForEvent
Description

Register for notifications of changed commitments for the given event. CommitmentReceiver.changedCommitments() is invoked when a commitment is changed.

Parametersosid.id.IdeventIdthe Id of the Event to monitor
ErrorsNULL_ARGUMENT eventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCommitmentsForResource
Description

Register for notifications of changed commitments for the given rsource. CommitmentReceiver.changedCommitments() is invoked when a commitment is changed.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCommitment
Description

Registers for notification of an updated commitment. CommitmentReceiver.changedCommitments() is invoked when the specified commitment is changed.

Parametersosid.id.IdcommitmentIdthe Id of the Commitment to monitor
ErrorsNULL_ARGUMENT commitmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCommitments
Description

Registers for notification of deleted commitments. CommitmentReceiver.deletedCommitments() is invoked when a commitment is deleted.

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

Register for notifications of deleted commitments by commitment genus type. CommitmentReceiver.deletedCommitments() is invoked when a commitment is deleted.

Parametersosid.id.IdcommitmentGenusTypethe commitment genus type to monitor
ErrorsNULL_ARGUMENT commitmentGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCommitmentsForEvent
Description

Register for notifications of deleted commitments for the given event. CommitmentReceiver.deletedCommitments() is invoked when a commitment is deleted.

Parametersosid.id.IdeventIdthe Id of the Event to monitor
ErrorsNULL_ARGUMENT eventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCommitmentsForResource
Description

Register for notifications of deleted commitments for the given rsource. CommitmentReceiver.deletedCommitments() is invoked when a commitment is deleted.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCommitment
Description

Registers for notification of a deleted commitment. CommitmentReceiver.changedCommitments() is invoked when the specified commitment is deleted.

Parametersosid.id.IdcommitmentIdthe Id of the Commitment to monitor
ErrorsNULL_ARGUMENT commitmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.