org.osid.ordering

Interface PriceScheduleStoreAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface PriceScheduleStoreAssignmentSession
extends OsidSession

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 ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignPriceScheduleToStore(Id pricScheduleeId, Id storeId) Adds an existing PriceSchedule to a Store.
boolean	canAssignPriceSchedules() Tests if this user can alter price schedule/store mappings.
boolean	canAssignPriceSchedulesToStore(Id storeId) Tests if this user can alter price schedule/store mappings.
IdList	getAssignableStoreIds(Id storeId) Gets a list of stores including and under the given store node in which any price schedule can be assigned.
IdList	getAssignableStoreIdsForPriceSchedule(Id storeId, Id priceScheduleId) Gets a list of stores including and under the given store node in which a specific price schedule can be assigned.
void	unassignPriceScheduleFromStore(Id priceScheduleId, Id storeId) Removes a PriceSchedule from a Store.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canAssignPriceSchedules

boolean canAssignPriceSchedules()

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.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignPriceSchedulesToStore

boolean canAssignPriceSchedulesToStore(Id storeId)

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.

Parameters:

storeId - the Id of the Store

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - storeId is null

Compliance:

mandatory - This method must be implemented.

getAssignableStoreIds

IdList getAssignableStoreIds(Id storeId)
                             throws OperationFailedException

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

Parameters:

storeId - the Id of the Store

Returns:

list of assignable store Ids

Throws:

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableStoreIdsForPriceSchedule

IdList getAssignableStoreIdsForPriceSchedule(Id storeId,
                                           Id priceScheduleId)
                                             throws OperationFailedException

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

Parameters:

storeId - the Id of the Store

priceScheduleId - the Id of the PriceSchedule

Returns:

list of assignable store Ids

Throws:

NullArgumentException - storeId or priceScheduleId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignPriceScheduleToStore

void assignPriceScheduleToStore(Id pricScheduleeId,
                              Id storeId)
                                throws AlreadyExistsException,
                                       NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Adds an existing PriceSchedule to a Store.

Parameters:

pricScheduleeId - the Id of the PriceSchedule

storeId - the Id of the Store

Throws:

AlreadyExistsException - priceScheduleId is already assigned to storeId

NotFoundException - priceScheduleId or storeId not found

NullArgumentException - priceScheduleId or storeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignPriceScheduleFromStore

void unassignPriceScheduleFromStore(Id priceScheduleId,
                                  Id storeId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Removes a PriceSchedule from a Store.

Parameters:

priceScheduleId - the Id of the PriceSchedule

storeId - the Id of the Store

Throws:

NotFoundException - priceScheduleId or storeId not found or priceScheduleId not assigned to storeId

NullArgumentException - priceScheduleId or storeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.