Interface | osid.ordering.rules.PriceEnablerQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Price enablers may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getStoreId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Store Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getStore | ||
Description |
Gets the | ||
Return | osid.ordering.Store | the store | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchPriceEnablers | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedStoreView | ||
Description |
Federates the view for methods in this session. A federated view will include price enablers in stores which are children of this broker in the store hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedStoreView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this store only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getPriceEnablerQuery | ||
Description |
Gets a price enabler query. | ||
Return | osid.ordering.rules.PriceEnablerQuery | the price enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getPriceEnablersByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.ordering.rules.PriceEnablerQuery | priceEnablerQuery | the price enabler query |
Return | osid.ordering.rules.PriceEnablerList | the returned PriceEnablerList | |
Errors | NULL_ARGUMENT | priceEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | priceEnablerQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |