Interface OrderStoreAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface OrderStoreAssignmentSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignOrderToStore(Id orderId, Id storeId)	Adds an existing Order to a Store .
boolean	canAssignOrders()	Tests if this user can alter order/store mappings.
boolean	canAssignOrdersToStore(Id storeId)	Tests if this user can alter order/store mappings.
IdList	getAssignableStoreIds(Id storeId)	Gets a list of stores including and under the given store node in which any order can be assigned.
IdList	getAssignableStoreIdsForOrder(Id storeId, Id orderId)	Gets a list of stores including and under the given store node in which a specific order can be assigned.
void	reassignOrderToStore(Id orderId, Id fromStoreId, Id toStoreId)	Moves an Order from one Store to another.
void	unassignOrderFromStore(Id orderId, Id storeId)	Removes an Order from a Store .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canAssignOrders

boolean canAssignOrders()

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.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignOrdersToStore

boolean canAssignOrdersToStore(Id storeId)

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.

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

getAssignableStoreIdsForOrder

IdList getAssignableStoreIdsForOrder(Id storeId,
 Id orderId)
                              throws OperationFailedException

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

Parameters:

storeId - the Id of the Store

orderId - the Id of the Order

Returns:

list of assignable store Ids

Throws:

NullArgumentException - storeId or orderId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignOrderToStore

void assignOrderToStore(Id orderId,
 Id storeId)
                 throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing Order to a Store .

Parameters:

orderId - the Id of the Order

storeId - the Id of the Store

Throws:

AlreadyExistsException - orderId is already assigned to storeId

NotFoundException - orderId or storeId not found

NullArgumentException - orderId or storeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignOrderFromStore

void unassignOrderFromStore(Id orderId,
 Id storeId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an Order from a Store .

Parameters:

orderId - the Id of the Order

storeId - the Id of the Store

Throws:

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

NullArgumentException - orderId or storeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignOrderToStore

void reassignOrderToStore(Id orderId,
 Id fromStoreId,
 Id toStoreId)
                   throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves an Order from one Store to another. Mappings to other Stores are unaffected.

Parameters:

orderId - the Id of the Order

fromStoreId - the Id of the current Store

toStoreId - the Id of the destination Store

Throws:

AlreadyExistsException - orderId already assigned to storeId

NotFoundException - orderId, fromStoreId , or toStoreId not found or orderId not mapped to fromStoreId

NullArgumentException - orderId, fromStoreId , or toStoreId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.