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.
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.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getSourceId()
Id
representing the shipment. Id
mandatory
- This method must be implemented. Resource getSource() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasOrder()
true
if this shipment relates to an odrer,
false
otherwisemandatory
- This method must be implemented. Id getOrderId()
Id
associated with this shipment. Id
IllegalStateException
- hasOrder()
is
false
mandatory
- This method must be implemented. Order getOrder() throws OperationFailedException
IllegalStateException
- hasOrder()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DateTime getDate()
mandatory
- This method must be implemented. IdList getEntryIds()
Ids
of this shipment. Ids
mandatory
- This method must be implemented. EntryList getEntries() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. ShipmentRecord getShipmentRecord(Type shipmentRecordType) throws OperationFailedException
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
.shipmentRecordType
- the type of shipment record to retrieveNullArgumentException
- shipmentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(shipmentRecordType)
is false
mandatory
- This method must be implemented.