org.osid.ordering

Interface StoreQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

StoreSearchSession

public interface StoreQuerySession
extends OsidSession

This session provides methods for searching Store objects. The search query is constructed using the StoreQuery. The store record Type also specifies the record for the store query.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchStores() Tests if this user can perform Store searches.
StoreQuery	getStoreQuery() Gets a store query.
StoreList	getStoresByQuery(StoreQuery storeQuery) Gets a list of Stores matching the given store query.

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

canSearchStores

boolean canSearchStores()

Tests if this user can perform Store 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.

getStoreQuery

StoreQuery getStoreQuery()

Gets a store query.

Returns:

the store query

Compliance:

mandatory - This method must be implemented.

getStoresByQuery

StoreList getStoresByQuery(StoreQuery storeQuery)
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets a list of Stores matching the given store query.

Parameters:

storeQuery - the store query

Returns:

the returned StoreList

Throws:

NullArgumentException - storeQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - storeQuery is not of this service

Compliance:

mandatory - This method must be implemented.