OSID Logo
OSID Specifications
inventory shipment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.shipment.Entry
Implementsosid.OsidObject
osid.Subjugateable
Description

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

MethodgetStockId
Description

Gets the stock Id associated with this entry.

Returnosid.id.Idthe stock Id
CompliancemandatoryThis method must be implemented.
MethodgetStock
Description

Gets the stock associated with this entry.

Returnosid.inventory.Stockthe stock
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasModel
Description

Tests if this entry applied to a specific model.

Returnboolean true if applies to a specific model, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetModelId
Description

Gets the model Id associated with this entry.

Returnosid.id.Idthe model Id
ErrorsILLEGAL_STATE hasModel() is false
CompliancemandatoryThis method must be implemented.
MethodgetModel
Description

Gets the model associated with this entry.

Returnosid.inventory.Modelthe model
ErrorsILLEGAL_STATE hasModel() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasItem
Description

Tests if this entry applied to a specific item.

Returnboolean true if applies to a specific item, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetItemId
Description

Gets the item Id associated with this entry.

Returnosid.id.Idthe model Id
ErrorsILLEGAL_STATE hasModel() is false
CompliancemandatoryThis method must be implemented.
MethodgetItem
Description

Gets the item associated with this entry.

Returnosid.inventory.Itemthe item
ErrorsILLEGAL_STATE hasItem() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetQuantity
Description

Gets the quantity of the item.

Returndecimalthe quantity
CompliancemandatoryThis method is must be implemented.
MethodgetUnitType
Description

Gets the units of the quantity.

Returnosid.type.Typethe unit type
CompliancemandatoryThis method must be implemented.
MethodgetEntryRecord
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 .

Parametersosid.type.TypeentryRecordTypethe type of entry record to retrieve
Returnosid.inventory.shipment.records.EntryRecordthe entry record
ErrorsNULL_ARGUMENT entryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(entryRecordType) is false
CompliancemandatoryThis method must be implemented.