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

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

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.

MethodgetStoreId
Description

Gets the Store Id associated with this session.

Returnosid.id.Idthe Store Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetStore
Description

Gets the Store associated with this session.

Returnosid.ordering.Storethe store
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchOrders
Description

Tests if this user can perform susbcription searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not wish to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedStoreView
Description

Federates the view for methods in this session. A federated view will include entries in stores which are children of this store in the store hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedStoreView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this store only.

CompliancemandatoryThis method is must be implemented.
MethodgetOrderQuery
Description

Gets an order query.

Returnosid.ordering.OrderQuerythe order query
CompliancemandatoryThis method must be implemented.
MethodgetOrdersByQuery
Description

Gets a list of orders matching the given order query.

Parametersosid.ordering.OrderQueryorderQuerythe order query
Returnosid.ordering.OrderListthe returned OrderList
ErrorsNULL_ARGUMENT orderQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED orderQuery is not of this service
CompliancemandatoryThis method must be implemented.