OSID Logo
OSID Specifications
inventory shipment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.shipment.ShipmentSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidAggregateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderBySource
Description

Specifies a preference for ordering the result set by the source.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsSourceSearchOrder
Description

Tests if a resource search order is available.

Returnboolean true if a resource search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSourceSearchOrder
Description

Specifies a preference for ordering the result set by the source.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsSourceSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsSourceSearchOrder() is true.
MethodorderByOrder
Description

Specifies a preference for ordering the result set by the order.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsOrderSearchOrder
Description

Tests if an order search order is available.

Returnboolean true if an order search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetOrderSearchOrder
Description

Specifies a preference for ordering the result set by the order.

Returnosid.ordering.OrderSearchOrderthe order search order
ErrorsUNIMPLEMENTED supportsOrderSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsOrderSearchOrder() is true.
MethodorderByDate
Description

Specifies a preference for ordering the result set by the shipment date.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetShipmentSearchOrderRecord
Description

Gets the shipment search order record corresponding to the given shipment record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypeshipmentRecordTypea shipment record type
Returnosid.inventory.shipment.records.ShipmentSearchOrderRecordthe shipment search order record
ErrorsNULL_ARGUMENT shipmentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(shipmentRecordType) is false
CompliancemandatoryThis method must be implemented.