OSID Logo
OSID Specifications
billing package
Version 3.1.0
Interfaceosid.billing.Item
Implementsosid.OsidObject
Used Byosid.billing.Entry
osid.billing.ItemAdminSession
osid.billing.ItemList
osid.billing.ItemLookupSession
Description

An Item is a product or service.

MethodgetCategoryId
Description

Gets the category Id.

Returnosid.id.Id the category Id
Compliancemandatory This method is must be implemented.
MethodgetCategory
Description

Gets the item category.

Returnosid.billing.Category the category
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodhasAccount
Description

Tests if this item relates to s specific general ledger account.

Returnboolean true if this item has an account, false otherwise
Compliancemandatory This method must be implemented.
MethodgetAccountId
Description

Gets the account Id.

Returnosid.id.Id the account Id
ErrorsILLEGAL_STATE hasAccount() is false
Compliancemandatory This method is must be implemented.
MethodgetAccount
Description

Gets the item account.

Returnosid.financials.Account the account
ErrorsILLEGAL_STATE hasAccount() is false
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodhasProduct
Description

Tests if this item relates to s specific product.

Returnboolean true if this item has a product, false otherwise
Compliancemandatory This method must be implemented.
MethodgetProductId
Description

Gets the product Id.

Returnosid.id.Id the product Id
ErrorsILLEGAL_STATE hasProduct() is false
Compliancemandatory This method is must be implemented.
MethodgetProduct
Description

Gets the product.

Returnosid.ordering.Product the product
ErrorsILLEGAL_STATE hasProduct() is false
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAmount
Description

Gets the amount of this item.

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.
MethodisRecurring
Description

Tests if this item is a recurring charge.

Returnboolean true if this item is recurring, false if one-time
Compliancemandatory This method must be implemented.
MethodgetRecurringInterval
Description

Gets the recurring interval.

Returnosid.calendaring.Duration the interval
ErrorsILLEGAL_STATE isRecurring() is false
Compliancemandatory This method must be implemented.
MethodgetItemRecord
Description

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

Parametersosid.type.TypeitemRecordType the type of item record to retrieve
Returnosid.billing.records.ItemRecord the item record
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(itemRecordType) is false
Compliancemandatory This method must be implemented.