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
).
Modifier and Type | Method and 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 |
unassignOrderFromStore(Id orderId,
Id storeId)
Removes an
Order from a Store. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignOrders()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignOrdersToStore(Id storeId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users.storeId
- the Id
of the Store
false
if mapping is not authorized, true
otherwiseNullArgumentException
- storeId
is
null
mandatory
- This method must be implemented. IdList getAssignableStoreIds(Id storeId) throws OperationFailedException
storeId
- the Id
of the Store
Ids
NullArgumentException
- storeId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableStoreIdsForOrder(Id storeId, Id orderId) throws OperationFailedException
storeId
- the Id
of the Store
orderId
- the Id
of the Order
Ids
NullArgumentException
- storeId
or
orderId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignOrderToStore(Id orderId, Id storeId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Order
to a Store.
orderId
- the Id
of the Order
storeId
- the Id
of the Store
AlreadyExistsException
- orderId
is
already assigned to storeId
NotFoundException
- orderId
or
storeId
not foundNullArgumentException
- orderId
or
storeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignOrderFromStore(Id orderId, Id storeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Order
from a Store.
orderId
- the Id
of the Order
storeId
- the Id
of the Store
NotFoundException
- orderId
or
storeId
not found or orderId
not
assigned to storeId
NullArgumentException
- orderId
or
storeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.