Interface PriceEnablerStoreSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PriceEnablerStoreSession
extends OsidSession

This session provides methods to retrieve PriceEnabler to Store mappings. A PriceEnabler may appear in multiple Store objects. 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	canLookupPriceEnablerStoreMappings()	Tests if this user can perform lookups of price enabler/store mappings.
IdList	getPriceEnablerIdsByStore(Id storeId)	Gets the list of PriceEnablerIds associated with a Store .
IdList	getPriceEnablerIdsByStores(IdList storeIds)	Gets the list of PriceEnabler Ids corresponding to a list of Stores .
PriceEnablerList	getPriceEnablersByStore(Id storeId)	Gets the list of price enablers associated with a Store .
PriceEnablerList	getPriceEnablersByStores(IdList storeIds)	Gets the list of price enablers corresponding to a list of Stores .
IdList	getStoreIdsByPriceEnabler(Id priceEnablerId)	Gets the Store Ids mapped to a PriceEnabler .
StoreList	getStoresByPriceEnabler(Id priceEnablerId)	Gets the Stores mapped to a PriceEnabler .
void	useComparativePriceEnablerStoreView()	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	usePlenaryPriceEnablerStoreView()	A complete view of the PriceEnabler 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

canLookupPriceEnablerStoreMappings

boolean canLookupPriceEnablerStoreMappings()

Tests if this user can perform lookups of price enabler/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 intended as 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.

useComparativePriceEnablerStoreView

void useComparativePriceEnablerStoreView()

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.

usePlenaryPriceEnablerStoreView

void usePlenaryPriceEnablerStoreView()

A complete view of the PriceEnabler 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.

getPriceEnablerIdsByStore

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

Gets the list of PriceEnablerIds associated with a Store .

Parameters:

storeId - Id of the Store

Returns:

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

getPriceEnablersByStore

PriceEnablerList getPriceEnablersByStore(Id storeId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of price enablers associated with a Store .

Parameters:

storeId - Id of the Store

Returns:

list of related price enablers

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.

getPriceEnablerIdsByStores

IdList getPriceEnablerIdsByStores(IdList storeIds)
                           throws OperationFailedException,
PermissionDeniedException

Gets the list of PriceEnabler Ids corresponding to a list of Stores .

Parameters:

storeIds - list of store Ids

Returns:

list of price enabler Ids

Throws:

NullArgumentException - storeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPriceEnablersByStores

PriceEnablerList getPriceEnablersByStores(IdList storeIds)
                                   throws OperationFailedException,
PermissionDeniedException

Gets the list of price enablers corresponding to a list of Stores .

Parameters:

storeIds - list of store Ids

Returns:

list of price enablers

Throws:

NullArgumentException - storeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStoreIdsByPriceEnabler

IdList getStoreIdsByPriceEnabler(Id priceEnablerId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Store Ids mapped to a PriceEnabler .

Parameters:

priceEnablerId - Id of a PriceEnabler

Returns:

list of stores

Throws:

NotFoundException - priceEnablerId is not found

NullArgumentException - priceEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStoresByPriceEnabler

StoreList getStoresByPriceEnabler(Id priceEnablerId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Stores mapped to a PriceEnabler .

Parameters:

priceEnablerId - Id of a PriceEnabler

Returns:

list of stores

Throws:

NotFoundException - priceEnablerId is not found

NullArgumentException - priceEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.