org.osid.ordering

Interface ProductQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

ProductSearchSession

public interface ProductQuerySession
extends OsidSession

This session provides methods for searching Product objects. The search query is constructed using the ProductQuery. The product record Type also specifies the record for the product query.

Products may have a query record indicated by their respective record types. The query record is accessed via the ProductQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchProducts() Tests if this user can perform Product searches.
ProductQuery	getProductQuery() Gets a product query.
ProductList	getProductsByQuery(ProductQuery productQuery) Gets a list of Products matching the given product query.
Store	getStore() Gets the Store associated with this session.
Id	getStoreId() Gets the Store Id associated with this session.
void	useFederatedStoreView() Federates the view for methods in this session.
void	useIsolatedStoreView() Isolates the view for methods in this session.

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.

canSearchProducts

boolean canSearchProducts()

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

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedStoreView

void useFederatedStoreView()

Federates the view for methods in this session. A federated view will include products in stores which are children of this store in the store hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedStoreView

void useIsolatedStoreView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this store only.

Compliance:

mandatory - This method is must be implemented.

getProductQuery

ProductQuery getProductQuery()

Gets a product query.

Returns:

the product query

Compliance:

mandatory - This method must be implemented.

getProductsByQuery

ProductList getProductsByQuery(ProductQuery productQuery)
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets a list of Products matching the given product query.

Parameters:

productQuery - the product query

Returns:

the returned ProductList

Throws:

NullArgumentException - productQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - productQuery is not of this service

Compliance:

mandatory - This method must be implemented.