Interface StoreSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, StoreQuerySession

public interface StoreSearchSession
extends StoreQuerySession

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.

getStoresByQuery() is the basic search method and returns a list of Store elements. A more advanced search may be performed with getStoresBySearch(). It accepts a StoreSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getStoresBySearch() returns a StoreSearchResults that can be used to access the resulting StoreList or be used to perform a search within the result set through StoreSearch.

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

Modifier and Type	Method	Description
StoreQuery	getStoreQueryFromInspector(StoreQueryInspector storeQueryInspector)	Gets an entry query from an inspector.
StoreSearchResults	getStoresBySearch(StoreQuery storeQuery, StoreSearch storeSearch)	Gets the search results matching the given search.
StoreSearch	getStoreSearch()	Gets a store search.
StoreSearchOrder	getStoreSearchOrder()	Gets a store search order.

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.

Methods inherited from interface StoreQuerySession

canSearchStores, getStoreQuery, getStoresByQuery

Modifier and Type	Method	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.

Method Details

getStoreSearch

StoreSearch getStoreSearch()

Gets a store search.

Returns:

the store search

Compliance:

mandatory - This method must be implemented.

getStoreSearchOrder

StoreSearchOrder getStoreSearchOrder()

Gets a store search order. The StoreSearchOrder is supplied to a StoreSearch to specify the ordering of results.

Returns:

the store search order

Compliance:

mandatory - This method must be implemented.

getStoresBySearch

StoreSearchResults getStoresBySearch(StoreQuery storeQuery,
 StoreSearch storeSearch)
                              throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

storeQuery - the store query

storeSearch - the store search

Returns:

the store search results

Throws:

NullArgumentException - storeQuery or storeSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - storeQuery or storeSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getStoreQueryFromInspector

StoreQuery getStoreQueryFromInspector(StoreQueryInspector storeQueryInspector)

Gets an entry query from an inspector. The inspector is available from a StoreSearchResults.

Parameters:

storeQueryInspector - a query inspector

Returns:

the store query

Throws:

NullArgumentException - storeQueryInspector is null

UnsupportedException - storeQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.