OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.PeriodNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Period objects in this Business. This also includes existing periods that may appear or disappear due to changes in the Business hierarchy, 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 PeriodLookupSession.

MethodgetBusinessId
Description

Gets the Business Id associated with this session.

Returnosid.id.Idthe Business Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBusiness
Description

Gets the Business associated with this session.

Returnosid.billing.Businessthe business
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForPeriodNotifications
Description

Tests if this user can register for Period 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.
MethoduseFederatedBusinessView
Description

Federates the view for methods in this session. A federated view will include periods in catalogs which are children of this catalog in the business hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBusinessView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodreliablePeriodNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliablePeriodNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgePeriodNotification
Description

Acknowledge a period notification.

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

Register for notifications of new periods. PeriodReceiver.newPeriods() is invoked when a new Period appears in this business.

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

Registers for notification of updated customers. PeriodReceiver.changedPeriods() is invoked when a period in this business is changed.

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

Registers for notification of an updated period. PeriodReceiver.changedPeriods() is invoked when the specified period in this business is changed.

Parametersosid.id.IdperiodIdthe Id of the Period to monitor
ErrorsNULL_ARGUMENT periodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPeriods
Description

Registers for notification of deleted periods. PeriodReceiver.deletedPeriods() is invoked when a period is deleted or removed from this business.

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

Registers for notification of a deleted period. PeriodReceiver.deletedPeriods() is invoked when the specified period is deleted or removed from this business.

Parametersosid.id.IdperiodIdthe Id of the Period to monitor
ErrorsNULL_ARGUMENT periodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.