public interface Entry extends OsidRelationship
An Entry
is a relationship between a customer and item
in a billing period.
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.
|
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getCustomerId()
Id
associated with this entry. Id
mandatory
- This method must be implemented. Customer getCustomer() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getItemId()
Id
associated with this entry. Id
mandatory
- This method must be implemented. Item getItem() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getPeriodId()
Id
of the Period
of this
offering. Period
Id
mandatory
- This method must be implemented. Period getPeriod() throws OperationFailedException
Period
of this offering.OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. long getQuantity()
IllegalStateException
- hasProduct()
is
false
mandatory
- This method is must be implemented. Currency getAmount()
mandatory
- This method must be implemented. boolean isDebit()
true
if this item amount is a debit,
false
if it is a creditmandatory
- This method must be implemented. EntryRecord getEntryRecord(Type entryRecordType) throws OperationFailedException
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
.entryRecordType
- the type of entry record to retrieveNullArgumentException
- entryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(entryRecordType)
is false
mandatory
- This method must be implemented.