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

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

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

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignPriceEnablersToStore
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup 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 price enabler 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.
MethodgetAssignableStoreIdsForPriceEnabler
Description

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

Parametersosid.id.IdstoreIdthe Id of the Store
osid.id.IdpriceEnablerIdthe Id of the PriceEnabler
Returnosid.id.IdListlist of assignable store Ids
ErrorsNULL_ARGUMENT storeId or priceEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignPriceEnablerToStore
Description

Adds an existing PriceEnabler to an Store.

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

Removes a PriceEnabler from an Store.

Parametersosid.id.IdpriceEnablerIdthe Id of the PriceEnabler
osid.id.IdstoreIdthe Id of the Store
ErrorsNOT_FOUND priceEnablerId or storeId not found or priceEnablerId is not assigned to storeId
NULL_ARGUMENT priceEnablerId or storeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignPriceEnablerToStore
Description

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

Parametersosid.id.IdpriceEnablerIdthe Id of the PriceEnabler
osid.id.IdfromStoreIdthe Id of the current Store
osid.id.IdtoStoreIdthe Id of the destination Store
ErrorsNOT_FOUND priceEnabelrId, fromStoreId, or toStoreId not found or priceEnablerId not mapped to fromStoreId
NULL_ARGUMENT priceEnabelrId, fromStoreId, or toStoreId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.