| Interface | osid.billing.Entry | ||
|---|---|---|---|
| Implements | osid.OsidRelationship | ||
| Description |
An | ||
| Method | getCustomerId | ||
| Description |
Gets the customer | ||
| Return | osid.id.Id | the customer Id | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCustomer | ||
| Description |
Gets the customer associated with this entry. | ||
| Return | osid.billing.Customer | the customer | |
| Errors | OPERATION_FAILED | unable to complete request | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getItemId | ||
| Description |
Gets the item | ||
| Return | osid.id.Id | the item Id | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getItem | ||
| Description |
Gets the item associated with this entry. | ||
| Return | osid.billing.Item | the item | |
| Errors | OPERATION_FAILED | unable to complete request | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPeriodId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Period Id | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPeriod | ||
| Description |
Gets the | ||
| Return | osid.billing.Period | the period | |
| Errors | OPERATION_FAILED | unable to complete request | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getQuantity | ||
| Description |
Gets the quantity of the item. | ||
| Return | cardinal | the quantity | |
| Errors | ILLEGAL_STATE | hasProduct() is false | |
| Compliance | mandatory | This method is must be implemented. | |
| Method | getAmount | ||
| Description |
Gets the amount of this entry. | ||
| Return | osid.financials.Currency | the amount | |
| Compliance | mandatory | This method must be implemented. | |
| Method | isDebit | ||
| Description |
Tests if the amount is a debit or a credit. | ||
| Return | boolean | true if this item amount is a debit, false if
it is a credit | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntryRecord | ||
| Description |
Gets the entry record corresponding to the given | ||
| Parameters | osid.type.Type | entryRecordType | the type of entry record to retrieve |
| Return | osid.billing.records.EntryRecord | the entry record | |
| Errors | NULL_ARGUMENT | entryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(entryRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |