Interface ShipmentSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ShipmentSearch
extends OsidSearch

The search interface for governing shipment searches.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongShipments

void searchAmongShipments(IdList shipmentIds)

Execute this search among the given list of shipments.

Parameters:

shipmentIds - list of shipments

Throws:

NullArgumentException - shipmentIds is null

Compliance:

mandatory - This method must be implemented.

orderShipmentResults

void orderShipmentResults(ShipmentSearchOrder shipmentSearchOrder)

Specify an ordering to the search results.

Parameters:

shipmentSearchOrder - shipment search order

Throws:

NullArgumentException - shipmentSearchOrder is null

UnsupportedException - shipmentSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getShipmentSearchRecord

ShipmentSearchRecord getShipmentSearchRecord(Type shipmentSearchRecordType)
                                      throws OperationFailedException

Gets the shipment search record corresponding to the given shipment search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

shipmentSearchRecordType - a shipment search record type

Returns:

the shipment search record

Throws:

NullArgumentException - shipmentSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(shipmentSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.