OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.OrderStoreAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign Odrers to Stores. An Order may map to multiple Stores and removing the last reference to an Order is the equivalent of deleting it. Each Store may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an Order to another Store is not a copy operation (eg: does not change its Id ).

MethodcanAssignOrders
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignOrdersToStore
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parametersosid.id.IdstoreIdthe Id of the Store
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT storeId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableStoreIds
Description

Gets a list of stores including and under the given store node in which any order can be assigned.

Parametersosid.id.IdstoreIdthe Id of the Store
Returnosid.id.IdListlist of assignable store Ids
ErrorsNULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableStoreIdsForOrder
Description

Gets a list of stores including and under the given store node in which a specific order can be assigned.

Parametersosid.id.IdstoreIdthe Id of the Store
osid.id.IdorderIdthe Id of the Order
Returnosid.id.IdListlist of assignable store Ids
ErrorsNULL_ARGUMENT storeId or orderId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignOrderToStore
Description

Adds an existing Order to a Store.

Parametersosid.id.IdorderIdthe Id of the Order
osid.id.IdstoreIdthe Id of the Store
ErrorsALREADY_EXISTS orderId is already assigned to storeId
NOT_FOUND orderId or storeId not found
NULL_ARGUMENT orderId or storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignOrderFromStore
Description

Removes an Order from a Store.

Parametersosid.id.IdorderIdthe Id of the Order
osid.id.IdstoreIdthe Id of the Store
ErrorsNOT_FOUND orderId or storeId not found or orderId not assigned to storeId
NULL_ARGUMENT orderId or storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.