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

Interface	osid.inventory.shipment.ShipmentSearchSession
Implements	`osid.inventory.shipment.ShipmentQuerySession`
Used By	`osid.inventory.shipment.InventoryShipmentManager`
Used By	`osid.inventory.shipment.InventoryShipmentProxyManager`
Description	This session provides methods for searching among `Shipments`. The search query is constructed using the `ShipmentQuery`. `getShipmentsByQuery()` is the basic search method and returns a list of `Shipments`. A more advanced search may be performed with `getShipmentsBySearch()`.It accepts a `ShipmentSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getShipmentsBySearch()` returns a `ShipmentSearchResults` that can be used to access the resulting `ShipmentList` or be used to perform a search within the result set through `ShipmentSearch`. This session defines views that offer differing behaviors for searching. federated warehouse view: searches include shipments in warehouses of which this warehouse is an ancestor in the warehouse hierarchy isolated warehouse view: searches are restricted to shipments in this warehouse Shipments may have a query record indicated by their respective record types. The query record is accessed via the `ShipmentQuery`.
Method	getShipmentSearch
Description	Gets a shipment search.
Return	`osid.inventory.shipment.ShipmentSearch`		the shipment search
Compliance	`mandatory`		This method must be implemented.
Method	getShipmentSearchOrder
Description	Gets a shipment search order. The `ShipmentSearchOrder` is supplied to a `ShipmentSearch` to specify the ordering of results.
Return	`osid.inventory.shipment.ShipmentSearchOrder`		the shipment search order
Compliance	`mandatory`		This method must be implemented.
Method	getShipmentsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.inventory.shipment.ShipmentQuery`	`shipmentQuery`	the shipment query
Parameters	`osid.inventory.shipment.ShipmentSearch`	`shipmentSearch`	the shipment search
Return	`osid.inventory.shipment.ShipmentSearchResults`		the shipment search results
Errors	NULL_ARGUMENT		`shipmentQuery` or `shipmentSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`shipmentQuery` or `shipmentSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getShipmentQueryFromInspector
Description	Gets a shipment query from an inspector. The inspector is available from a `ShipmentSearchResults`.
Parameters	`osid.inventory.shipment.ShipmentQueryInspector`	`shipmentQueryInspector`	a shipment query inspector
Return	`osid.inventory.shipment.ShipmentQuery`		the shipment query
Errors	NULL_ARGUMENT		`shipmentQueryInspector` is `null`
Errors	UNSUPPORTED		`shipmentQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.