org.osid.ordering.rules

Interface PriceEnablerSmartStoreSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface PriceEnablerSmartStoreSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic stores. A PriceEnablerQuery can be retrieved from this session and mapped to this Store to create a virtual collection of price enablers. The price enablers may be sequenced using the PriceEnablerSearchOrder from this session.

This Store has a default query that matches any price enabler and a default search order that specifies no sequencing. The queries may be examined using a PriceEnablerQueryInspector. The query may be modified by converting the inspector back to a PriceEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyPriceEnablerQuery(PriceEnablerQuery priceEnablerQuery) Applies a price enabler query to this store.
void	applyPriceEnablerSequencing(PriceEnablerSearchOrder priceEnablerSearchOrder) Applies a price enabler search order to this store.
boolean	canManageSmartStores() Tests if this user can manage smart stores.
PriceEnablerQuery	getPriceEnablerQuery() Gets a price enabler query.
PriceEnablerQuery	getPriceEnablerQueryFromInspector(PriceEnablerQueryInspector priceEnablerQueryInspector) Gets a price enabler query from an inspector.
PriceEnablerSearchOrder	getPriceEnablerSearchOrder() Gets a price enabler search order.
Store	getStore() Gets the Store associated with this session.
Id	getStoreId() Gets the Store Id associated with this session.
PriceEnablerQueryInspector	inspectPriceEnablerQuery() Gets a price enabler query inspector for this store.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getStoreId

Id getStoreId()

Gets the Store Id associated with this session.

Returns:

the Store Id associated with this session

Compliance:

mandatory - This method must be implemented.

getStore

Store getStore()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the Store associated with this session.

Returns:

the store

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartStores

boolean canManageSmartStores()

Tests if this user can manage smart stores. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart store management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getPriceEnablerQuery

PriceEnablerQuery getPriceEnablerQuery()

Gets a price enabler query.

Returns:

the price enabler query

Compliance:

mandatory - This method must be implemented.

getPriceEnablerSearchOrder

PriceEnablerSearchOrder getPriceEnablerSearchOrder()

Gets a price enabler search order.

Returns:

the price enabler search order

Compliance:

mandatory - This method must be implemented.

applyPriceEnablerQuery

void applyPriceEnablerQuery(PriceEnablerQuery priceEnablerQuery)
                            throws OperationFailedException,
                                   PermissionDeniedException

Applies a price enabler query to this store.

Parameters:

priceEnablerQuery - the price enabler query

Throws:

NullArgumentException - priceEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - priceEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectPriceEnablerQuery

PriceEnablerQueryInspector inspectPriceEnablerQuery()
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets a price enabler query inspector for this store.

Returns:

the price enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyPriceEnablerSequencing

void applyPriceEnablerSequencing(PriceEnablerSearchOrder priceEnablerSearchOrder)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Applies a price enabler search order to this store.

Parameters:

priceEnablerSearchOrder - the price enabler search order

Throws:

NullArgumentException - priceEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - priceEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getPriceEnablerQueryFromInspector

PriceEnablerQuery getPriceEnablerQueryFromInspector(PriceEnablerQueryInspector priceEnablerQueryInspector)

Gets a price enabler query from an inspector.

Parameters:

priceEnablerQueryInspector - a price enabler query inspector

Returns:

the price enabler query

Throws:

NullArgumentException - priceEnablerQueryInspector is null

UnsupportedException - priceEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.