org.osid.inventory.shipment

Interface Entry

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, Subjugateable

public interface Entry
extends OsidObject, Subjugateable

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

Method Summary

Methods

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.

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

Method Detail

getStockId

Id getStockId()

Gets the stock Id associated with this entry.

Returns:

the stock Id

Compliance:

mandatory - This method must be implemented.

getStock

Stock getStock()
               throws OperationFailedException

Gets the stock associated with this entry.

Returns:

the stock

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasModel

boolean hasModel()

Tests if this entry applied to a specific model.

Returns:

true if applies to a specific model, false otherwise

Compliance:

mandatory - This method must be implemented.

getModelId

Id getModelId()

Gets the model Id associated with this entry.

Returns:

the model Id

Throws:

IllegalStateException - hasModel() is false

Compliance:

mandatory - This method must be implemented.

getModel

Model getModel()
               throws OperationFailedException

Gets the model associated with this entry.

Returns:

the model

Throws:

IllegalStateException - hasModel() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasItem

boolean hasItem()

Tests if this entry applied to a specific item.

Returns:

true if applies to a specific item, false otherwise

Compliance:

mandatory - This method must be implemented.

getItemId

Id getItemId()

Gets the item Id associated with this entry.

Returns:

the model Id

Throws:

IllegalStateException - hasModel() is false

Compliance:

mandatory - This method must be implemented.

getItem

Item getItem()
             throws OperationFailedException

Gets the item associated with this entry.

Returns:

the item

Throws:

IllegalStateException - hasItem() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getQuantity

java.math.BigDecimal getQuantity()

Gets the quantity of the item.

Returns:

the quantity

Compliance:

mandatory - This method is must be implemented.

getUnitType

Type getUnitType()

Gets the units of the quantity.

Returns:

the unit type

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.