OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.Entry
Implementsosid.OsidRelationship
Description

An Entry is a relationship between a customer and item in a billing period.

MethodgetCustomerId
Description

Gets the customer Id associated with this entry.

Returnosid.id.Idthe customer Id
CompliancemandatoryThis method must be implemented.
MethodgetCustomer
Description

Gets the customer associated with this entry.

Returnosid.billing.Customerthe customer
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetItemId
Description

Gets the item Id associated with this entry.

Returnosid.id.Idthe item Id
CompliancemandatoryThis method must be implemented.
MethodgetItem
Description

Gets the item associated with this entry.

Returnosid.billing.Itemthe item
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetPeriodId
Description

Gets the Id of the Period of this offering.

Returnosid.id.Idthe Period Id
CompliancemandatoryThis method must be implemented.
MethodgetPeriod
Description

Gets the Period of this offering.

Returnosid.billing.Periodthe period
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetQuantity
Description

Gets the quantity of the item.

Returncardinalthe quantity
ErrorsILLEGAL_STATE hasProduct() is false
CompliancemandatoryThis method is must be implemented.
MethodgetAmount
Description

Gets the amount of this entry.

Returnosid.financials.Currencythe amount
CompliancemandatoryThis method must be implemented.
MethodisDebit
Description

Tests if the amount is a debit or a credit.

Returnboolean true if this item amount is a debit, false if it is a credit
CompliancemandatoryThis method must be implemented.
MethodgetEntryRecord
Description

Gets the entry record corresponding to the given Entry record Type. This method is used to retrieve an object implementing the requested record. The entryRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(entryRecordType) is true .

Parametersosid.type.TypeentryRecordTypethe type of entry record to retrieve
Returnosid.billing.records.EntryRecordthe entry record
ErrorsNULL_ARGUMENT entryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(entryRecordType) is false
CompliancemandatoryThis method must be implemented.