OSID Logo
OSID Specifications
acknowledgement package
Version 3.0.0
Release Candidate Preview
Interfaceosid.acknowledgement.CreditNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Credit objects. 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.

MethodgetBillingId
Description

Gets the Billing Id associated with this session.

Returnosid.id.Idthe Billing Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBilling
Description

Gets the Billing associated with this session.

Returnosid.acknowledgement.Billingthe billing
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForCreditNotifications
Description

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

Federates the view for methods in this session. A federated view will include notifications for credits in billings which are children of this billing in the billing hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBillingView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodreliableCreditNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableCreditNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeCreditNotification
Description

Acknowledge a credit notification.

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

Register for notifications of new credits. CreditReceiver.newCredits() is invoked when a new Credit is created.

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

Register for notifications of new credits by the given credit genus Type. CreditReceiver.newCredits() is invoked when a new Credit appears in this billing.

Parametersosid.type.TypecreditGenusTypethe Id of the reference to monitor
ErrorsNULL_ARGUMENT creditGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCreditsForReference
Description

Register for notifications of new credits for the given reference Id. CreditReceiver.newCredits() is invoked when a new Credit appears in this billing.

Parametersosid.id.IdreferenceIdthe reference to monitor
ErrorsNULL_ARGUMENT referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCreditsForResource
Description

Register for notifications of new credits for the given resource Id. CreditReceiver.newCredits() is invoked when a new Credit appears in this billing.

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

Registers for notification of updated credits. CreditReceiver.changedCredits() is invoked when a credit in this billing is changed.

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

Register for notifications of changed credits by the given credit gfenus Type. CreditReceiver.changedCredits() is invoked when a Credit for the reference in this billing is changed.

Parametersosid.type.TypecreditGenusTypethe genus type of the credit to monitor
ErrorsNULL_ARGUMENT creditGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCreditsForReference
Description

Register for notifications of changed credits for the given reference Id. CreditReceiver.changedCredits() is invoked when a Credit for the reference in this billing is changed.

Parametersosid.id.IdreferenceIdthe Id of the reference to monitor
ErrorsNULL_ARGUMENT referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCreditsForResource
Description

Register for notifications of changed credits for the given resource Id. CreditReceiver.changedCredits() is invoked when a Credit for the resource is changed in this billing.

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

Registers for notification of an updated credit. CreditReceiver.changedCredits() is invoked when the specified credit in this billing is changed.

Parametersosid.id.IdcreditIdthe Id of the Credit to monitor
ErrorsNOT_FOUNDa credit was not found identified by the given Id
NULL_ARGUMENT creditId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCredits
Description

Registers for notification of deleted credits. CreditReceiver.deletedCredit() is invoked when a credit is removed from this billing.

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

Register for notifications of deleted credits by the credit genus Type. CreditReceiver.deletedCredit() is invoked when a Credit for the reference is removed from this billing.

Parametersosid.type.TypecreditGenusTypethe genus type of the credit to monitor
ErrorsNULL_ARGUMENT creditGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCreditsForReference
Description

Register for notifications of deleted credits for the given reference Id. CreditReceiver.deletedCredit() is invoked when a Credit for the reference is removed from this billing.

Parametersosid.id.IdreferenceIdthe Id of the reference to monitor
ErrorsNULL_ARGUMENT referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCreditsForResource
Description

Register for notifications of deleted credits for the given resource Id. CreditReceiver.deletedCredit() is invoked when a Credit for the resource is removed from this billing.

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

Registers for notification of a deleted credit. CreditReceiver.deletedCredit() is invoked when the specified credit is removed from this billing.

Parametersosid.id.IdcreditIdthe Id of the Credit to monitor
ErrorsNOT_FOUNDa credit was not found identified by the given Id
NULL_ARGUMENT creditId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.