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

Interface	osid.inventory.shipment.ShipmentQueryInspector
Implements	`osid.OsidObjectQueryInspector`
Implements	`osid.OsidAggregateableQueryInspector`
Used By	`osid.inventory.shipment.ShipmentSearchResults`
Used By	`osid.inventory.shipment.ShipmentSmartWarehouseSession`
Description	The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to `OsidQuery` interfaces for reuse or modification in the search sessions. Like all `OsidQueryInspectors`, `ShipmentQueryInspector` is stateful and must not be accessed by multiple processing threads.
Method	getSourceIdTerms
Description	Gets the resource `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the resource `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getSourceTerms
Description	Gets the resource query terms.
Return	`osid.resource.ResourceQueryInspector[]`		the resource query terms
Compliance	`mandatory`		This method must be implemented.
Method	getOrderIdTerms
Description	Gets the order `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the order `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getOrderTerms
Description	Gets the order query terms.
Return	`osid.ordering.OrderQueryInspector[]`		the order query terms
Compliance	`mandatory`		This method must be implemented.
Method	getDateTerms
Description	Gets the date terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the date terms
Compliance	`mandatory`		This method must be implemented.
Method	getEntryIdTerms
Description	Gets the entry `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the entry `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getEntryTerms
Description	Gets the entry query terms.
Return	`osid.inventory.shipment.EntryQueryInspector[]`		the entry query terms
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouseIdTerms
Description	Gets the warehouse `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the warehouse `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouseTerms
Description	Gets the warehouse query terms.
Return	`osid.inventory.WarehouseQueryInspector[]`		the warehouse query terms
Compliance	`mandatory`		This method must be implemented.
Method	getShipmentQueryInspectorRecord
Description	Gets the shipment query inspector record corresponding to the given `Shipment` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`shipmentRecordType`	a shipment record type
Return	`osid.inventory.shipment.records.ShipmentQueryInspectorRecord`		the shipment query inspector record
Errors	NULL_ARGUMENT		`shipmentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(shipmentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.