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

Interface	osid.inventory.shipment.Shipment
Implements	`osid.OsidObject`
Implements	`osid.Aggregateable`
Used By	`osid.inventory.shipment.ShipmentAdminSession`
	`osid.inventory.shipment.ShipmentList`
	`osid.inventory.shipment.ShipmentLookupSession`
Description	A `Shipment` represents data associated to a resource representing a shipment. Contact information for this object can be managed in the Contact OSID.
Method	getSourceId
Description	Gets the resource `Id` representing the shipment.
Return	`osid.id.Id`		the resource `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getSource
Description	Gets the resource.
Return	`osid.resource.Resource`		the resource
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasOrder
Description	Tests if this shipment has a related order.
Return	`boolean`		`true` if this shipment relates to an odrer, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOrderId
Description	Gets the order `Id` associated with this shipment.
Return	`osid.id.Id`		the order `Id`
Errors	ILLEGAL_STATE		`hasOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getOrder
Description	Gets the order associated with this shipment.
Return	`osid.ordering.Order`		the order
Errors	ILLEGAL_STATE		`hasOrder()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getDate
Description	Gets the date this shipment was received.
Return	`osid.calendaring.DateTime`		the received date
Compliance	`mandatory`		This method must be implemented.
Method	getEntryIds
Description	Gets the entry `Ids` of this shipment.
Return	`osid.id.IdList`		the entry `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getEntries
Description	Gets the entries of this shipment.
Return	`osid.inventory.shipment.EntryList`		the entries
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getShipmentRecord
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`.
Parameters	`osid.type.Type`	`shipmentRecordType`	the type of shipment record to retrieve
Return	`osid.inventory.shipment.records.ShipmentRecord`		the shipment record
Errors	NULL_ARGUMENT		`shipmentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(shipmentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.