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

This session provides methods to re-assign Products to Stores. A Product may map to multiple Stores and removing the last reference to a Product 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 a Product to another Store is not a copy operation (eg: does not change its Id ).

MethodcanAssignProducts
Description

Tests if this user can alter product/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.
MethodcanAssignProductsToStore
Description

Tests if this user can alter product/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 product 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.
MethodgetAssignableStoreIdsForProduct
Description

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

Parametersosid.id.IdstoreIdthe Id of the Store
osid.id.IdproductIdthe Id of the Product
Returnosid.id.IdListlist of assignable store Ids
ErrorsNULL_ARGUMENT storeId or productId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignProductToStore
Description

Adds an existing Product to a Store.

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

Removes a Product from a Store.

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