Interface | osid.ordering.OrderStoreAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of an | ||
Method | canAssignOrders | ||
Description |
Tests if this user can alter order/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 | canAssignOrdersToStore | ||
Description |
Tests if this user can alter order/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 order 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 | getAssignableStoreIdsForOrder | ||
Description |
Gets a list of stores including and under the given store node in which a specific order can be assigned. | ||
Parameters | osid.id.Id | storeId | the Id of the Store |
osid.id.Id | orderId | the Id of the Order | |
Return | osid.id.IdList | list of assignable store Ids | |
Errors | NULL_ARGUMENT | storeId or orderId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignOrderToStore | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | orderId | the Id of the Order |
osid.id.Id | storeId | the Id of the Store | |
Errors | ALREADY_EXISTS | orderId is already assigned to storeId | |
NOT_FOUND | orderId or storeId not found | ||
NULL_ARGUMENT | orderId or storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignOrderFromStore | ||
Description |
Removes an | ||
Parameters | osid.id.Id | orderId | the Id of the Order |
osid.id.Id | storeId | the Id of the Store | |
Errors | NOT_FOUND | orderId or storeId not found or
orderId not assigned to storeId | |
NULL_ARGUMENT | orderId or storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |