Interface PriceStoreSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PriceStoreSession
extends OsidSession

This session provides methods to retrieve Price to Store mappings. A Price 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

Like all OsidSessions, PriceStoreSessions are dedicated to single processing threads and a single authenticated user.

Method Summary

Modifier and Type	Method	Description
boolean	canLookupPriceStoreMappings()	Tests if this user can perform lookups of price schedule/store mappings.
IdList	getPriceIdsByStore(Id storeId)	Gets the list of Price Ids associated with a Store.
IdList	getPriceIdsByStores(IdList storeIds)	Gets the list of Price Ids corresponding to a list of Store objects.
PriceList	getPricesByStore(Id storeId)	Gets the list of Prices associated with a Store.
PriceList	getPricesByStores(IdList storeIds)	Gets the list of Prices corresponding to a list of Stores.
IdList	getStoreIdsByPrice(Id priceId)	Gets the list of Store Ids mapped to a Price.
StoreList	getStoresByPrice(Id priceId)	Gets the list of Store objects mapped to a Price.
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 Price and Store returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatTypes, getLocales, isAuthenticated, startTransaction, supportsTransactions

Method Details

canLookupPriceStoreMappings

boolean canLookupPriceStoreMappings()

Tests if this user can perform lookups of price schedule/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 must be implemented.

usePlenaryStoreView

void usePlenaryStoreView()

A complete view of the Price 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 must be implemented.

getPriceIdsByStore

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

Gets the list of Price Ids associated with a Store.

Parameters:

storeId - Id of a Store.

Returns:

list of related price 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.

getPricesByStore

PriceList getPricesByStore(Id storeId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Prices associated with a Store.

Parameters:

storeId - Id of a Store

Returns:

list of related prices

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.

getPriceIdsByStores

IdList getPriceIdsByStores(IdList storeIds)
                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

storeIds - list of store Ids

Returns:

list of price Ids

Throws:

NullArgumentException - storeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPricesByStores

PriceList getPricesByStores(IdList storeIds)
                     throws OperationFailedException,
PermissionDeniedException

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

Parameters:

storeIds - list of store Ids

Returns:

list of prices

Throws:

NullArgumentException - storeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStoreIdsByPrice

IdList getStoreIdsByPrice(Id priceId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Store Ids mapped to a Price.

Parameters:

priceId - Id of a Price

Returns:

list of store Ids

Throws:

NotFoundException - priceId is not found

NullArgumentException - priceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStoresByPrice

StoreList getStoresByPrice(Id priceId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Store objects mapped to a Price.

Parameters:

priceId - Id of a Price

Returns:

list of stores

Throws:

NotFoundException - priceId is not found

NullArgumentException - priceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.