Interface PriceEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, PriceEnablerQuerySession

public interface PriceEnablerSearchSession
extends PriceEnablerQuerySession

This session provides methods for searching among PriceEnabler objects. The search query is constructed using the PriceEnableryQuery.

getPriceEnablersByQuery() is the basic search method and returns a list of PriceEnablers. A more advanced search may be performed with getPriceEnablersBySearch().It accepts a PriceEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPriceEnablersBySearch() returns a PriceEnablerSearchResults that can be used to access the resulting PriceEnablerList or be used to perform a search within the result set through PriceEnablerSearch.

This session defines views that offer differing behaviors for searching.

• federated store view: searches include price enablers in stores of which this store is an ancestor in the store hierarchy
• isolated store view: searches are restricted to price enablers in this store

PriceEnablers may have a query record indicated by their respective record types. The query record is accessed via the PriceEnablerQuery.

Method Summary

Modifier and Type	Method	Description
PriceEnablerQuery	getPriceEnablerQueryFromInspector(PriceEnablerQueryInspector priceEnablerQueryInspector)	Gets a price enabler query from an inspector.
PriceEnablerSearchResults	getPriceEnablersBySearch(PriceEnablerQuery priceEnablerQuery, PriceEnablerSearch priceEnablerSearch)	Gets the search results matching the given search query using the given search.
PriceEnablerSearch	getPriceEnablerSearch()	Gets a price enabler search.
PriceEnablerSearchOrder	getPriceEnablerSearchOrder()	Gets a price enabler 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 PriceEnablerQuerySession

canSearchPriceEnablers, getPriceEnablerQuery, getPriceEnablersByQuery, getStore, getStoreId, useFederatedStoreView, useIsolatedStoreView

Modifier and Type	Method	Description
boolean	canSearchPriceEnablers()	Tests if this user can perform PriceEnabler lookups.
PriceEnablerQuery	getPriceEnablerQuery()	Gets a price enabler query.
PriceEnablerList	getPriceEnablersByQuery(PriceEnablerQuery priceEnablerQuery)	Gets a list of PriceEnablers matching the given price enabler 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.

Method Details

getPriceEnablerSearch

PriceEnablerSearch getPriceEnablerSearch()

Gets a price enabler search.

Returns:

the price enabler search

Compliance:

mandatory - This method must be implemented.

getPriceEnablerSearchOrder

PriceEnablerSearchOrder getPriceEnablerSearchOrder()

Gets a price enabler search order. The PriceEnablerSearchOrder is supplied to a PriceEnablerSearch to specify the ordering of results.

Returns:

the price enabler search order

Compliance:

mandatory - This method must be implemented.

getPriceEnablersBySearch

PriceEnablerSearchResults getPriceEnablersBySearch(PriceEnablerQuery priceEnablerQuery,
 PriceEnablerSearch priceEnablerSearch)
                                            throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

priceEnablerQuery - the price enabler query

priceEnablerSearch - the price enabler search

Returns:

the price enabler search results

Throws:

NullArgumentException - priceEnablerQuery or priceEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - priceEnablerQuery or priceEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPriceEnablerQueryFromInspector

PriceEnablerQuery getPriceEnablerQueryFromInspector(PriceEnablerQueryInspector priceEnablerQueryInspector)

Gets a price enabler query from an inspector. The inspector is available from a PriceEnablerSearchResults.

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.