Interface | osid.acknowledgement.CreditBillingAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignCredits | ||
Description |
Tests if this user can alter credit/billing mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignCreditsToBilling | ||
Description |
Tests if this user can alter credit/billing mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Parameters | osid.id.Id | billingId | the Id of the Billing |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | billingId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableBillingIds | ||
Description |
Gets a list of billings including and under the given billing node in which any credit can be assigned. | ||
Parameters | osid.id.Id | billingId | the Id of the Billing |
Return | osid.id.IdList | list of assignable billing Ids | |
Errors | NULL_ARGUMENT | billingId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableBillingIdsForCredit | ||
Description |
Gets a list of billings including and under the given billing node in which a specific credit can be assigned. | ||
Parameters | osid.id.Id | billingId | the Id of the Billing |
osid.id.Id | creditId | the Id of the Credit | |
Return | osid.id.IdList | list of assignable billing Ids | |
Errors | NULL_ARGUMENT | billingId or creditId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignCreditToBilling | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | creditId | the Id of the Credit |
osid.id.Id | billingId | the Id of the Billing | |
Errors | ALREADY_EXISTS | creditId already assigned to billingId | |
NOT_FOUND | creditId or billingId not found | ||
NULL_ARGUMENT | creditId or billingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignCreditFromBilling | ||
Description |
Removes a | ||
Parameters | osid.id.Id | creditId | the Id of the Credit |
osid.id.Id | billingId | the Id of the Billing | |
Errors | NOT_FOUND | creditId or billingId not found or
creditId not mapped to billingId | |
NULL_ARGUMENT | creditId or billingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignCreditToBilling | ||
Description |
Moves a | ||
Parameters | osid.id.Id | creditId | the Id of the Credit |
osid.id.Id | fromBillingId | the Id of the current Billing | |
osid.id.Id | toBiillingId | the Id of the destination Billing | |
Errors | NOT_FOUND | creditId, fromBillingId, or toBillingId not
found or creditId not mapped to fromBillingId | |
NULL_ARGUMENT | creditId, billingId, or toBillingId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |