public interface ShipmentSearch extends OsidSearch
The search interface for governing shipment searches.
Modifier and Type | Method and Description |
---|---|
ShipmentSearchRecord |
getShipmentSearchRecord(Type shipmentSearchRecordType)
Gets the shipment search record corresponding to the given shipment
search record
Type. |
void |
orderShipmentResults(ShipmentSearchOrder shipmentSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongShipments(IdList shipmentIds)
Execute this search among the given list of shipments.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongShipments(IdList shipmentIds)
shipmentIds
- list of shipmentsNullArgumentException
- shipmentIds
is
null
mandatory
- This method must be implemented. void orderShipmentResults(ShipmentSearchOrder shipmentSearchOrder)
shipmentSearchOrder
- shipment search orderNullArgumentException
- shipmentSearchOrder
is null
UnsupportedException
- shipmentSearchOrder
is not of this servicemandatory
- This method must be implemented. ShipmentSearchRecord getShipmentSearchRecord(Type shipmentSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.shipmentSearchRecordType
- a shipment search record typeNullArgumentException
- shipmentSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(shipmentSearchRecordType)
is
false
mandatory
- This method must be implemented.