Interface OrderStoreSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface OrderStoreSession
extends OsidSession

This session provides methods to retrieve Order to Store mappings. An Order may appear in multiple Stores. Each Store may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupOrderStoreMappings()	Tests if this user can perform lookups of order/store mappings.
IdList	getOrderIdsByStore(Id storeId)	Gets the list of order Ids associated with a Store.
IdList	getOrderIdsByStores(IdList storeIds)	Gets the list of Order Ids corresponding to a list of Store objects.
OrderList	getOrdersByStore(Id storeId)	Gets the list of Orders associated with a Store.
OrderList	getOrdersByStores(IdList storeIds)	Gets the list of Orders corresponding to a list of Stores.
IdList	getStoreIdsByOrder(Id orderId)	Gets the list of Store Ids mapped to an Order.
StoreList	getStoresByOrder(Id orderId)	Gets the list of Store objects mapped to an Order.
void	useComparativeStoreView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryStoreView()	A complete view of the Order and Store returns is desired.

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

canLookupOrderStoreMappings

boolean canLookupOrderStoreMappings()

Tests if this user can perform lookups of order/store mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeStoreView

void useComparativeStoreView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryStoreView

void usePlenaryStoreView()

A complete view of the Order and Store returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getOrderIdsByStore

IdList getOrderIdsByStore(Id storeId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of order Ids associated with a Store.

Parameters:

storeId - Id of a Store.

Returns:

list of related order Ids

Throws:

NotFoundException - storeId is not found

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOrdersByStore

OrderList getOrdersByStore(Id storeId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Orders associated with a Store.

Parameters:

storeId - Id of a Store

Returns:

list of related orders

Throws:

NotFoundException - storeId is not found

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOrderIdsByStores

IdList getOrderIdsByStores(IdList storeIds)
                    throws OperationFailedException,
PermissionDeniedException

Gets the list of Order Ids corresponding to a list of Store objects.

Parameters:

storeIds - list of store Ids

Returns:

list of order Ids

Throws:

NullArgumentException - storeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOrdersByStores

OrderList getOrdersByStores(IdList storeIds)
                     throws OperationFailedException,
PermissionDeniedException

Gets the list of Orders corresponding to a list of Stores.

Parameters:

storeIds - list of store Ids

Returns:

list of orders

Throws:

NullArgumentException - storeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStoreIdsByOrder

IdList getStoreIdsByOrder(Id orderId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Store Ids mapped to an Order.

Parameters:

orderId - Id of an Order

Returns:

list of store Ids

Throws:

NotFoundException - orderId is not found

NullArgumentException - orderId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStoresByOrder

StoreList getStoresByOrder(Id orderId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Store objects mapped to an Order.

Parameters:

orderId - Id of an Order

Returns:

list of store Ids

Throws:

NotFoundException - orderId is not found

NullArgumentException - orderId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.