org.osid.billing

Interface Entry

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface Entry
extends OsidRelationship

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

Method Summary

Methods

Modifier and Type	Method and Description
Currency	getAmount() Gets the amount of this entry.
Customer	getCustomer() Gets the customer associated with this entry.
Id	getCustomerId() Gets the customer Id associated with this entry.
EntryRecord	getEntryRecord(Type entryRecordType) Gets the entry record corresponding to the given Entry record Type.
Item	getItem() Gets the item associated with this entry.
Id	getItemId() Gets the item Id associated with this entry.
Period	getPeriod() Gets the Period of this offering.
Id	getPeriodId() Gets the Id of the Period of this offering.
long	getQuantity() Gets the quantity of the item.
boolean	isDebit() Tests if the amount is a debit or a credit.

Methods inherited from interface org.osid.OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getCustomerId

Id getCustomerId()

Gets the customer Id associated with this entry.

Returns:

the customer Id

Compliance:

mandatory - This method must be implemented.

getCustomer

Customer getCustomer()
                     throws OperationFailedException

Gets the customer associated with this entry.

Returns:

the customer

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getItemId

Id getItemId()

Gets the item Id associated with this entry.

Returns:

the item Id

Compliance:

mandatory - This method must be implemented.

getItem

Item getItem()
             throws OperationFailedException

Gets the item associated with this entry.

Returns:

the item

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getPeriodId

Id getPeriodId()

Gets the Id of the Period of this offering.

Returns:

the Period Id

Compliance:

mandatory - This method must be implemented.

getPeriod

Period getPeriod()
                 throws OperationFailedException

Gets the Period of this offering.

Returns:

the period

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getQuantity

long getQuantity()

Gets the quantity of the item.

Returns:

the quantity

Throws:

IllegalStateException - hasProduct() is false

Compliance:

mandatory - This method is must be implemented.

getAmount

Currency getAmount()

Gets the amount of this entry.

Returns:

the amount

Compliance:

mandatory - This method must be implemented.

isDebit

boolean isDebit()

Tests if the amount is a debit or a credit.

Returns:

true if this item amount is a debit, false if it is a credit

Compliance:

mandatory - This method must be implemented.

getEntryRecord

EntryRecord getEntryRecord(Type entryRecordType)
                           throws OperationFailedException

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 .

Parameters:

entryRecordType - the type of entry record to retrieve

Returns:

the entry record

Throws:

NullArgumentException - entryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(entryRecordType) is false

Compliance:

mandatory - This method must be implemented.