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

A Shipment represents data associated to a resource representing a shipment. Contact information for this object can be managed in the Contact OSID.

MethodgetSourceId
Description

Gets the resource Id representing the shipment.

Returnosid.id.Idthe resource Id
CompliancemandatoryThis method must be implemented.
MethodgetSource
Description

Gets the resource.

Returnosid.resource.Resourcethe resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasOrder
Description

Tests if this shipment has a related order.

Returnboolean true if this shipment relates to an odrer, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetOrderId
Description

Gets the order Id associated with this shipment.

Returnosid.id.Idthe order Id
ErrorsILLEGAL_STATE hasOrder() is false
CompliancemandatoryThis method must be implemented.
MethodgetOrder
Description

Gets the order associated with this shipment.

Returnosid.ordering.Orderthe order
ErrorsILLEGAL_STATE hasOrder() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetDate
Description

Gets the date this shipment was received.

Returnosid.calendaring.DateTimethe received date
CompliancemandatoryThis method must be implemented.
MethodgetEntryIds
Description

Gets the entry Ids of this shipment.

Returnosid.id.IdListthe entry Ids
CompliancemandatoryThis method must be implemented.
MethodgetEntries
Description

Gets the entries of this shipment.

Returnosid.inventory.shipment.EntryListthe entries
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetShipmentRecord
Description

Gets the shipment record corresponding to the given Shipment record Type. This method is used to retrieve an object implementing the requested record. The shipmentRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(shipmentRecordType) is true .

Parametersosid.type.TypeshipmentRecordTypethe type of shipment record to retrieve
Returnosid.inventory.shipment.records.ShipmentRecordthe shipment record
ErrorsNULL_ARGUMENT shipmentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(shipmentRecordType) is false
CompliancemandatoryThis method must be implemented.