org.osid.inventory.shipment

Interface Shipment

All Superinterfaces:

Aggregateable, Browsable, Extensible, Identifiable, OsidObject

public interface Shipment
extends OsidObject, Aggregateable

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

Method Summary

Methods

Modifier and Type	Method and Description
DateTime	getDate() Gets the date this shipment was received.
EntryList	getEntries() Gets the entries of this shipment.
IdList	getEntryIds() Gets the entry Ids of this shipment.
Order	getOrder() Gets the order associated with this shipment.
Id	getOrderId() Gets the order Id associated with this shipment.
ShipmentRecord	getShipmentRecord(Type shipmentRecordType) Gets the shipment record corresponding to the given Shipment record Type.
Resource	getSource() Gets the resource.
Id	getSourceId() Gets the resource Id representing the shipment.
boolean	hasOrder() Tests if this shipment has a related order.

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

getSourceId

Id getSourceId()

Gets the resource Id representing the shipment.

Returns:

the resource Id

Compliance:

mandatory - This method must be implemented.

getSource

Resource getSource()
                   throws OperationFailedException

Gets the resource.

Returns:

the resource

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasOrder

boolean hasOrder()

Tests if this shipment has a related order.

Returns:

true if this shipment relates to an odrer, false otherwise

Compliance:

mandatory - This method must be implemented.

getOrderId

Id getOrderId()

Gets the order Id associated with this shipment.

Returns:

the order Id

Throws:

IllegalStateException - hasOrder() is false

Compliance:

mandatory - This method must be implemented.

getOrder

Order getOrder()
               throws OperationFailedException

Gets the order associated with this shipment.

Returns:

the order

Throws:

IllegalStateException - hasOrder() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getDate

DateTime getDate()

Gets the date this shipment was received.

Returns:

the received date

Compliance:

mandatory - This method must be implemented.

getEntryIds

IdList getEntryIds()

Gets the entry Ids of this shipment.

Returns:

the entry Ids

Compliance:

mandatory - This method must be implemented.

getEntries

EntryList getEntries()
                     throws OperationFailedException

Gets the entries of this shipment.

Returns:

the entries

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getShipmentRecord

ShipmentRecord getShipmentRecord(Type shipmentRecordType)
                                 throws OperationFailedException

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:

shipmentRecordType - the type of shipment record to retrieve

Returns:

the shipment record

Throws:

NullArgumentException - shipmentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(shipmentRecordType) is false

Compliance:

mandatory - This method must be implemented.