Interface | osid.acknowledgement.CreditNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | getBillingId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Billing Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBilling | ||
Description |
Gets the | ||
Return | osid.acknowledgement.Billing | the billing | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForCreditNotifications | ||
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 | useFederatedBillingView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedBillingView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this billing only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableCreditNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableCreditNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeCreditNotification | ||
Description |
Acknowledge a credit 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 | registerForNewCredits | ||
Description |
Register for notifications of new credits. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewCreditsByGenusType | ||
Description |
Register for notifications of new credits by the given
credit genus | ||
Parameters | osid.type.Type | creditGenusType | the Id of the reference to monitor |
Errors | NULL_ARGUMENT | creditGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewCreditsForReference | ||
Description |
Register for notifications of new credits for the given
reference | ||
Parameters | osid.id.Id | referenceId | the reference to monitor |
Errors | NULL_ARGUMENT | referenceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewCreditsForResource | ||
Description |
Register for notifications of new credits for the given
resource | ||
Parameters | osid.id.Id | resourceId | the Id of the resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCredits | ||
Description |
Registers for notification of updated credits. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCreditsByGenusType | ||
Description |
Register for notifications of changed credits by the
given credit gfenus | ||
Parameters | osid.type.Type | creditGenusType | the genus type of the credit to monitor |
Errors | NULL_ARGUMENT | creditGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCreditsForReference | ||
Description |
Register for notifications of changed credits for the
given reference | ||
Parameters | osid.id.Id | referenceId | the Id of the reference to monitor |
Errors | NULL_ARGUMENT | referenceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCreditsForResource | ||
Description |
Register for notifications of changed credits for the
given resource | ||
Parameters | osid.id.Id | resourceId | the Id of the resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedCredit | ||
Description |
Registers for notification of an updated credit. | ||
Parameters | osid.id.Id | creditId | the Id of the Credit to monitor |
Errors | NOT_FOUND | a credit was not found identified by the given Id | |
NULL_ARGUMENT | creditId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCredits | ||
Description |
Registers for notification of deleted credits. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCreditsByGenusType | ||
Description |
Register for notifications of deleted credits by the
credit genus | ||
Parameters | osid.type.Type | creditGenusType | the genus type of the credit to monitor |
Errors | NULL_ARGUMENT | creditGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCreditsForReference | ||
Description |
Register for notifications of deleted credits for the
given reference | ||
Parameters | osid.id.Id | referenceId | the Id of the reference to monitor |
Errors | NULL_ARGUMENT | referenceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCreditsForResource | ||
Description |
Register for notifications of deleted credits for the
given resource | ||
Parameters | osid.id.Id | resourceId | the Id of the resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedCredit | ||
Description |
Registers for notification of a deleted credit. | ||
Parameters | osid.id.Id | creditId | the Id of the Credit to monitor |
Errors | NOT_FOUND | a credit was not found identified by the given Id | |
NULL_ARGUMENT | creditId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |