public interface Entry extends OsidObject, Subjugateable
An Entry
is a relationship between a shipment and item
in a billing period.
Modifier and Type | Method and Description |
---|---|
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. |
Model |
getModel()
Gets the model associated with this entry.
|
Id |
getModelId()
Gets the model
Id associated with this entry. |
java.math.BigDecimal |
getQuantity()
Gets the quantity of the item.
|
Stock |
getStock()
Gets the stock associated with this entry.
|
Id |
getStockId()
Gets the stock
Id associated with this entry. |
Type |
getUnitType()
Gets the units of the quantity.
|
boolean |
hasItem()
Tests if this entry applied to a specific item.
|
boolean |
hasModel()
Tests if this entry applied to a specific model.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getStockId()
Id
associated with this entry. Id
mandatory
- This method must be implemented. Stock getStock() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasModel()
true
if applies to a specific model,
false
otherwisemandatory
- This method must be implemented. Id getModelId()
Id
associated with this entry. Id
IllegalStateException
- hasModel()
is
false
mandatory
- This method must be implemented. Model getModel() throws OperationFailedException
IllegalStateException
- hasModel()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasItem()
true
if applies to a specific item,
false
otherwisemandatory
- This method must be implemented. Id getItemId()
Id
associated with this entry. Id
IllegalStateException
- hasModel()
is
false
mandatory
- This method must be implemented. Item getItem() throws OperationFailedException
IllegalStateException
- hasItem()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. java.math.BigDecimal getQuantity()
mandatory
- This method is must be implemented. Type getUnitType()
mandatory
- 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.