OSID - osid.inventory.shipment.Entry Service Interface Definition

Interface	osid.inventory.shipment.Entry
Implements	`osid.OsidObject`
Implements	`osid.Subjugateable`
Used By	`osid.inventory.shipment.EntryList`
Used By	`osid.inventory.shipment.ShipmentAdminSession`
Description	An `Entry` is a part of a `Shipment` .
Method	getStockId
Description	Gets the stock `Id` associated with this entry.
Return	`osid.id.Id`		the stock `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getStock
Description	Gets the stock associated with this entry.
Return	`osid.inventory.Stock`		the stock
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasModel
Description	Tests if this entry applied to a specific model.
Return	`boolean`		`true` if applies to a specific model, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getModelId
Description	Gets the model `Id` associated with this entry.
Return	`osid.id.Id`		the model `Id`
Errors	ILLEGAL_STATE		`hasModel()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getModel
Description	Gets the model associated with this entry.
Return	`osid.inventory.Model`		the model
Errors	ILLEGAL_STATE		`hasModel()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasItem
Description	Tests if this entry applied to a specific item.
Return	`boolean`		`true` if applies to a specific item, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getItemId
Description	Gets the item `Id` associated with this entry.
Return	`osid.id.Id`		the model `Id`
Errors	ILLEGAL_STATE		`hasModel()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getItem
Description	Gets the item associated with this entry.
Return	`osid.inventory.Item`		the item
Errors	ILLEGAL_STATE		`hasItem()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getQuantity
Description	Gets the quantity of the item.
Return	`decimal`		the quantity
Compliance	`mandatory`		This method is must be implemented.
Method	getUnitType
Description	Gets the units of the quantity.
Return	`osid.type.Type`		the unit type
Compliance	`mandatory`		This method must be implemented.
Method	getEntryRecord
Description	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	`osid.type.Type`	`entryRecordType`	the type of entry record to retrieve
Return	`osid.inventory.shipment.records.EntryRecord`		the entry record
Errors	NULL_ARGUMENT		`entryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(entryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.