| Interface | osid.ordering.rules.PriceEnablerStoreAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | 
                 This session provides methods to re-assign   Adding a reference of a   | ||
| Method | canAssignPriceEnablers | ||
| Description | 
                     Tests if this user can alter price enabler/store 
                    mappings. A return of true does not guarantee successful 
                    authorization. A return of false indicates that it is 
                    known mapping methods in this session will result in a 
                      | ||
| Return | boolean |  false  if mapping is not authorized,  true  
otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignPriceEnablersToStore | ||
| Description | 
                     Tests if this user can alter price enabler/store 
                    mappings. A return of true does not guarantee successful 
                    authorization. A return of false indicates that it is 
                    known mapping methods in this session will result in a 
                      | ||
| Parameters | osid.id.Id | storeId | the  Id  of the  Store   | 
| Return | boolean |  false  if mapping is not authorized,  true  
otherwise  | |
| Errors | NULL_ARGUMENT |  storeId  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableStoreIds | ||
| Description | 
                     Gets a list of stores including and under the given store node in which any price enabler can be assigned.  | ||
| Parameters | osid.id.Id | storeId | the  Id  of the  Store   | 
| Return | osid.id.IdList | list of assignable store  Ids   | |
| Errors | NULL_ARGUMENT |  storeId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableStoreIdsForPriceEnabler | ||
| Description | 
                     Gets a list of stores including and under the given store node in which a specific price enabler can be assigned.  | ||
| Parameters | osid.id.Id | storeId | the  Id  of the  Store   | 
osid.id.Id | priceEnablerId | the  Id  of the  PriceEnabler   | |
| Return | osid.id.IdList | list of assignable store  Ids   | |
| Errors | NULL_ARGUMENT |  storeId  or  priceEnablerId  is  null 
  |                 |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignPriceEnablerToStore | ||
| Description | 
                     Adds an existing   | ||
| Parameters | osid.id.Id | priceEnablerId | the  Id  of the  PriceEnabler   | 
osid.id.Id | storeId | the  Id  of the  Store   | |
| Errors | ALREADY_EXISTS |  priceEnablerId  is already assigned to  storeId   |                 |
| NOT_FOUND |  priceEnablerId  or  storeId  not found  |                 ||
| NULL_ARGUMENT |  priceEnablerId  or  storeId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignPriceEnablerFromStore | ||
| Description | 
                     Removes a   | ||
| Parameters | osid.id.Id | priceEnablerId | the  Id  of the  PriceEnabler   | 
osid.id.Id | storeId | the  Id  of the  Store   | |
| Errors | NOT_FOUND |  priceEnablerId  or  storeId  not found or  
priceEnablerId  is not assigned to  storeId   |                 |
| NULL_ARGUMENT |  priceEnablerId  or  storeId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignPriceEnablerToStore | ||
| Description | 
                     Moves a   | ||
| Parameters | osid.id.Id | priceEnablerId | the  Id  of the  PriceEnabler   | 
osid.id.Id | fromStoreId | the  Id  of the current  Store   | |
osid.id.Id | toStoreId | the  Id  of the destination  Store   | |
| Errors | NOT_FOUND |  priceEnabelrId, fromStoreId,  or  toStoreId  not 
found or  priceEnablerId  not mapped to  fromStoreId 
  |                 |
| NULL_ARGUMENT |  priceEnabelrId, fromStoreId,  or  toStoreId  is 
 null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |