OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.OrderSearchSession
Implementsosid.ordering.OrderQuerySession
Description

This session provides methods for searching Order objects. The search query is constructed using the OrderQuery. The order record Type also specifies the record for the order query.

getOrdersByQuery() is the basic search method and returns a list of Order elements. A more advanced search may be performed with getOrdersBySearch(). It accepts an OrderSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getOrdersBySearch() returns an OrderSearchResults that can be used to access the resulting OrderList or be used to perform a search within the result set through OrderSearch.

Orders may have a query record indicated by their respective record types. The query record is accessed via the OrderQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetOrderSearch
Description

Gets an order search.

Returnosid.ordering.OrderSearchthe order search
CompliancemandatoryThis method must be implemented.
MethodgetOrderSearchOrder
Description

Gets an order search order. The OrderSearchOrder is supplied to an OrderSearch to specify the ordering of results.

Returnosid.ordering.OrderSearchOrderthe order search order
CompliancemandatoryThis method must be implemented.
MethodgetOrdersBySearch
Description

Gets the search results matching the given search.

Parametersosid.ordering.OrderQueryorderQuerythe order query
osid.ordering.OrderSearchorderSearchthe order search
Returnosid.ordering.OrderSearchResultsthe order search results
ErrorsNULL_ARGUMENT orderQuery or orderSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED orderQuery or orderSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetOrderQueryFromInspector
Description

Gets an entry query from an inspector. The inspector is available from an OrderSearchResults.

Parametersosid.ordering.OrderQueryInspectororderQueryInspectora query inspector
Returnosid.ordering.OrderQuerythe order query
ErrorsNULL_ARGUMENT orderQueryInspector is null
UNSUPPORTED orderQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.