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

This session provides methods for searching Store objects. The search query is constructed using the StoreQuery. The store record Type also specifies the record for the store query.

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

MethodcanSearchStores
Description

Tests if this user can perform Store 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 opt not to offer search operations to unauthorized users.

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

Gets a store query.

Returnosid.ordering.StoreQuerythe store query
CompliancemandatoryThis method must be implemented.
MethodgetStoresByQuery
Description

Gets a list of Stores matching the given store query.

Parametersosid.ordering.StoreQuerystoreQuerythe store query
Returnosid.ordering.StoreListthe returned StoreList
ErrorsNULL_ARGUMENT storeQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED storeQuery is not of this service
CompliancemandatoryThis method must be implemented.