Interface | osid.inventory.shipment.ShipmentSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
osid.OsidAggregateableSearchOrder | |||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderBySource | ||
Description |
Specifies a preference for ordering the result set by the source. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSourceSearchOrder | ||
Description |
Tests if a resource search order is available. | ||
Return | boolean | true if a resource search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSourceSearchOrder | ||
Description |
Specifies a preference for ordering the result set by the source. | ||
Return | osid.resource.ResourceSearchOrder | the resource search order | |
Errors | UNIMPLEMENTED | supportsSourceSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsSourceSearchOrder()
is true. | |
Method | orderByOrder | ||
Description |
Specifies a preference for ordering the result set by the order. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsOrderSearchOrder | ||
Description |
Tests if an order search order is available. | ||
Return | boolean | true if an order search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getOrderSearchOrder | ||
Description |
Specifies a preference for ordering the result set by the order. | ||
Return | osid.ordering.OrderSearchOrder | the order search order | |
Errors | UNIMPLEMENTED | supportsOrderSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsOrderSearchOrder()
is true. | |
Method | orderByDate | ||
Description |
Specifies a preference for ordering the result set by the shipment date. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentSearchOrderRecord | ||
Description |
Gets the shipment search order record corresponding to
the given shipment record | ||
Parameters | osid.type.Type | shipmentRecordType | a shipment record type |
Return | osid.inventory.shipment.records.ShipmentSearchOrderRecord | the shipment search order 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. |