Interface | osid.ordering.rules.PriceEnablerStoreSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupPriceEnablerStoreMappings | ||
Description |
Tests if this user can perform lookups of price
enabler/store mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativePriceEnablerStoreView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryPriceEnablerStoreView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getPriceEnablerIdsByStore | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | storeId | Id of the Store |
Return | osid.id.IdList | list of related price enabler Ids | |
Errors | NOT_FOUND | storeId is not found | |
NULL_ARGUMENT | storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPriceEnablersByStore | ||
Description |
Gets the list of price enablers associated with an
| ||
Parameters | osid.id.Id | storeId | Id of the Store |
Return | osid.ordering.rules.PriceEnablerList | list of related price enablers | |
Errors | NOT_FOUND | storeId is not found | |
NULL_ARGUMENT | storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPriceEnablerIdsByStores | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | storeIds | list of store Ids |
Return | osid.id.IdList | list of price enabler Ids | |
Errors | NULL_ARGUMENT | storeIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPriceEnablersByStores | ||
Description |
Gets the list of price enablers corresponding to a list
of | ||
Parameters | osid.id.IdList | storeIds | list of store Ids |
Return | osid.ordering.rules.PriceEnablerList | list of price enablers | |
Errors | NULL_ARGUMENT | storeIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStoreIdsByPriceEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | priceEnablerId | Id of a PriceEnabler |
Return | osid.id.IdList | list of stores | |
Errors | NOT_FOUND | priceEnablerId is not found | |
NULL_ARGUMENT | priceEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStoresByPriceEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | priceEnablerId | Id of a PriceEnabler |
Return | osid.ordering.StoreList | list of stores | |
Errors | NOT_FOUND | priceEnablerId is not found | |
NULL_ARGUMENT | priceEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |