OSID Logo
OSID Specifications
billing package
Version 3.1.0
Interfaceosid.billing.Entry
Implementsosid.OsidRelationship
Used Byosid.billing.EntryAdminSession
osid.billing.EntryList
osid.billing.EntryLookupSession
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.Id the customer Id
Compliancemandatory This method must be implemented.
MethodgetCustomer
Description

Gets the customer associated with this entry.

Returnosid.billing.Customer the customer
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetItemId
Description

Gets the item Id associated with this entry.

Returnosid.id.Id the item Id
Compliancemandatory This method must be implemented.
MethodgetItem
Description

Gets the item associated with this entry.

Returnosid.billing.Item the item
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetPeriodId
Description

Gets the Id of the Period of this offering.

Returnosid.id.Id the Period Id
Compliancemandatory This method must be implemented.
MethodgetPeriod
Description

Gets the Period of this offering.

Returnosid.billing.Period the period
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetQuantity
Description

Gets the quantity of the item.

Returncardinal the quantity
ErrorsILLEGAL_STATE hasProduct() is false
Compliancemandatory This method is must be implemented.
MethodgetAmount
Description

Gets the amount of this entry.

Returnosid.financials.Currency the amount
Compliancemandatory This 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
Compliancemandatory This 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.TypeentryRecordType the type of entry record to retrieve
Returnosid.billing.records.EntryRecord the entry record
ErrorsNULL_ARGUMENT entryRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(entryRecordType) is false
Compliancemandatory This method must be implemented.