OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.PriceScheduleStoreAssignmentSession
Implementsosid.OsidSession
Used Byosid.ordering.OrderingManager
osid.ordering.OrderingProxyManager
Description

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

MethodcanAssignPriceSchedules
Description

Tests if this user can alter price schedule/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
Compliancemandatory This method must be implemented.
MethodcanAssignPriceSchedulesToStore
Description

Tests if this user can alter price schedule/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 lookup assignment to unauthorized users.

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

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

Parametersosid.id.IdstoreId the Id of the Store
Returnosid.id.IdList list of assignable store Ids
ErrorsNULL_ARGUMENT storeId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableStoreIdsForPriceSchedule
Description

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

Parametersosid.id.IdstoreId the Id of the Store
osid.id.IdpriceScheduleId the Id of the PriceSchedule
Returnosid.id.IdList list of assignable store Ids
ErrorsNULL_ARGUMENT storeId or priceScheduleId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignPriceScheduleToStore
Description

Adds an existing PriceSchedule to a Store.

Parametersosid.id.IdpricScheduleeId the Id of the PriceSchedule
osid.id.IdstoreId the Id of the Store
ErrorsALREADY_EXISTS priceScheduleId is already assigned to storeId
NOT_FOUND priceScheduleId or storeId not found
NULL_ARGUMENT priceScheduleId or storeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignPriceScheduleFromStore
Description

Removes a PriceSchedule from a Store.

Parametersosid.id.IdpriceScheduleId the Id of the PriceSchedule
osid.id.IdstoreId the Id of the Store
ErrorsNOT_FOUND priceScheduleId or storeId not found or priceScheduleId not assigned to storeId
NULL_ARGUMENT priceScheduleId or storeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignPriceScheduleToStore
Description

Moves a PriceSchedule from one Store to another. Mappings to other Stores are unaffected.

Parametersosid.id.IdpriceScheduleId the Id of the PriceSchedule
osid.id.IdfromStoreId the Id of the current Store
osid.id.IdtoStoreId the Id of the destination Store
ErrorsALREADY_EXISTS priceScheduleId already assigned to storeId
NOT_FOUND priceScheduleId, fromStoreId, or toStoreId not found or priceScheduleId not mapped to fromStoreId
NULL_ARGUMENT priceScheduleId, fromStoreId, or toStoreId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.