org.osid.ordering.rules

Interface PriceEnablerSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.ordering.rules.PriceEnablerQuerySession

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

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

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.