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

Interface	osid.inventory.shipment.ShipmentQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidAggregateableQuery`
Used By	`osid.inventory.shipment.ShipmentQuerySession`
	`osid.inventory.shipment.ShipmentSearchSession`
	`osid.inventory.shipment.ShipmentSmartWarehouseSession`
Description	This is the query for searching shipments. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchSourceId
Description	Sets the resource `Id` for this query.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSourceIdTerms
Description	Clears the resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSourceQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSourceQuery
Description	Gets the query for a source. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		a resource query
Errors	UNIMPLEMENTED		`supportsSourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSourceQuery()` is `true`.
Method	matchAnySource
Description	Matches shipments with any source.
Parameters	`boolean`	`match`	`true` to match shipments with any source, `false` to match shipments with no source
Compliance	`mandatory`		This method must be implemented.
Method	clearSourceTerms
Description	Clears the source terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOrderId
Description	Sets the order `Id` for this query.
Parameters	`osid.id.Id`	`orderId`	an order `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`orderId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearOrderIdTerms
Description	Clears the order `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOrderQuery
Description	Tests if an `OrderQuery` is available.
Return	`boolean`		`true` if an order query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOrderQuery
Description	Gets the query for an order. Multiple retrievals produce a nested `OR` term.
Return	`osid.ordering.OrderQuery`		an odrer query
Errors	UNIMPLEMENTED		`supportsOrderQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOrderQuery()` is `true`.
Method	matchAnyOrder
Description	Matches shipments with any related order.
Parameters	`boolean`	`match`	`true` to match shipments with any related order, `false` to match shipments with no order
Compliance	`mandatory`		This method must be implemented.
Method	clearOrderTerms
Description	Clears the order terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDate
Description	Matches shipment dates within the given date range inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	start of range
	`osid.calendaring.DateTime`	`to`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDate
Description	Matches shipments with any date.
Parameters	`boolean`	`match`	`true` to match shipments with any date, `false` to match shipments with no date
Compliance	`mandatory`		This method must be implemented.
Method	clearDateTerms
Description	Clears the shipment date.
Compliance	`mandatory`		This method must be implemented.
Method	matchEntryId
Description	Sets the entry `Id` for this query.
Parameters	`osid.id.Id`	`entryId`	an entry `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`entryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEntryIdTerms
Description	Clears the entry `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryQuery
Description	Tests if an `EntryQuery` is available.
Return	`boolean`		`true` if an entry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEntryQuery
Description	Gets the query for an entry. Multiple retrievals produce a nested `OR` term.
Return	`osid.inventory.shipment.EntryQuery`		an entry query
Errors	UNIMPLEMENTED		`supportsEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryQuery()` is `true`.
Method	matchAnyEntry
Description	Matches shipments that have any entry.
Parameters	`boolean`	`match`	`true` to match shipments with any entry, `false` to match shipments with no entries
Compliance	`mandatory`		This method must be implemented.
Method	clearEntryTerms
Description	Clears the entry terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchWarehouseId
Description	Sets the warehouse `Id` for this query to match shipments assigned to warehouses.
Parameters	`osid.id.Id`	`warehouseId`	the warehouse `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`warehouseId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearWarehouseIdTerms
Description	Clears the warehouse `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsWarehouseQuery
Description	Tests if a `WarehouseQuery` is available.
Return	`boolean`		`true` if a warehouse query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouseQuery
Description	Gets the query for a warehouse. Multiple retrievals produce a nested `OR` term.
Return	`osid.inventory.WarehouseQuery`		the warehouse query
Errors	UNIMPLEMENTED		`supportsWarehouseQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWarehouseQuery()` is `true`.
Method	clearWarehouseTerms
Description	Clears the warehouse terms.
Compliance	`mandatory`		This method must be implemented.
Method	getShipmentQueryRecord
Description	Gets the shipment query 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.ShipmentQueryRecord`		the shipment query 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.