Interface | osid.ordering.ProductSmartStoreSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
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 associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartStores | ||
Description |
Tests if this user can manage smart stores. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart store management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProductQuery | ||
Description |
Gets a product query. | ||
Return | osid.ordering.ProductQuery | the product query | |
Compliance | mandatory | This method must be implemented. | |
Method | getProductSearchOrder | ||
Description |
Gets a product search order. | ||
Return | osid.ordering.ProductSearchOrder | the product search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyProductQuery | ||
Description |
Applies a product query to this store. | ||
Parameters | osid.ordering.ProductQuery | productQuery | the product query |
Errors | NULL_ARGUMENT | productQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | productQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectProductQuery | ||
Description |
Gets a product query inspector for this store. | ||
Return | osid.ordering.ProductQueryInspector | the product query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyProductSequencing | ||
Description |
Applies a product search order to this store. | ||
Parameters | osid.ordering.ProductSearchOrder | productSearchOrder | the product search order |
Errors | NULL_ARGUMENT | productSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | productSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProductQueryFromInspector | ||
Description |
Gets a product query from an inspector. | ||
Parameters | osid.ordering.ProductQueryInspector | productQueryInspector | a query inspector |
Return | osid.ordering.ProductQuery | the product query | |
Errors | NULL_ARGUMENT | productQueryInspector is null | |
UNSUPPORTED | productQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |