Interface | osid.acknowledgement.BillingLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | canLookupBillings | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeBillingView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryBillingView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getBilling | ||
Description |
Gets the | ||
Parameters | osid.id.Id | billingId | Id of the Billing |
Return | osid.acknowledgement.Billing | the billing | |
Errors | NOT_FOUND | billingId not found | |
NULL_ARGUMENT | billingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getBillingsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | billingIds | the list of Ids to retrieve |
Return | osid.acknowledgement.BillingList | the returned Billing list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | billingIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBillingsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | billingGenusType | a billing genus type |
Return | osid.acknowledgement.BillingList | the returned Billing list | |
Errors | NULL_ARGUMENT | billingGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBillingsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | billingGenusType | a billing genus type |
Return | osid.acknowledgement.BillingList | the returned Billing list | |
Errors | NULL_ARGUMENT | billingGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBillingsByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | billingRecordType | a billing record type |
Return | osid.acknowledgement.BillingList | the returned Billing list | |
Errors | NULL_ARGUMENT | billingRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBillingsByProvider | ||
Description |
Gets a | ||
Parameters | osid.id.Id | providerId | a provider Id |
Return | osid.acknowledgement.BillingList | the returned Billing list | |
Errors | NULL_ARGUMENT | providerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBillings | ||
Description |
Gets all | ||
Return | osid.acknowledgement.BillingList | a list of Billings | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |