Interface PriceScheduleSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, PriceScheduleQuerySession

public interface PriceScheduleSearchSession
extends PriceScheduleQuerySession

This session provides methods for searching PriceSchedule objects. The search query is constructed using the PriceScheduleQuery. The price schedule record Type also specifies the record for the price schedule query.

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

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

Method Summary

Modifier and Type	Method	Description
PriceScheduleQuery	getPriceScheduleQueryFromInspector(PriceScheduleQueryInspector priceScheduleQueryInspector)	Gets a price schedule query from an inspector.
PriceScheduleSearchResults	getPriceSchedulesBySearch(PriceScheduleQuery priceScheduleQuery, PriceScheduleSearch priceScheduleSearch)	Gets the price schedule search results matching the given search.
PriceScheduleSearch	getPriceScheduleSearch()	Gets a price schedule search.
PriceScheduleSearchOrder	getPriceScheduleSearchOrder()	Gets a price schedule 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 PriceScheduleQuerySession

canSearchPriceSchedules, getPriceScheduleQuery, getPriceSchedulesByQuery, getStore, getStoreId, useFederatedStoreView, useIsolatedStoreView

Modifier and Type	Method	Description
boolean	canSearchPriceSchedules()	Tests if this user can perform PriceSchedule searches.
PriceScheduleQuery	getPriceScheduleQuery()	Gets a price schedule query.
PriceScheduleList	getPriceSchedulesByQuery(PriceScheduleQuery priceScheduleQuery)	Gets a list of PriceSchedules matching the given price schedule 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

getPriceScheduleSearch

PriceScheduleSearch getPriceScheduleSearch()

Gets a price schedule search.

Returns:

the price search

Compliance:

mandatory - This method must be implemented.

getPriceScheduleSearchOrder

PriceScheduleSearchOrder getPriceScheduleSearchOrder()

Gets a price schedule search order. The PriceScheduleSearchOrder is supplied to a PriceScheduleSearch to specify the ordering of results.

Returns:

the price schedule search order

Compliance:

mandatory - This method must be implemented.

getPriceSchedulesBySearch

PriceScheduleSearchResults getPriceSchedulesBySearch(PriceScheduleQuery priceScheduleQuery,
 PriceScheduleSearch priceScheduleSearch)
                                              throws OperationFailedException,
PermissionDeniedException

Gets the price schedule search results matching the given search.

Parameters:

priceScheduleQuery - the price schedule query

priceScheduleSearch - the price schedule search

Returns:

the price schedule search results

Throws:

NullArgumentException - priceScheduleQuery or priceScheduleSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - priceScheduleQuery or priceScheduleSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPriceScheduleQueryFromInspector

PriceScheduleQuery getPriceScheduleQueryFromInspector(PriceScheduleQueryInspector priceScheduleQueryInspector)

Gets a price schedule query from an inspector. The inspector is available from a PriceScheduleSearchResults.

Parameters:

priceScheduleQueryInspector - a query inspector

Returns:

the price schedule query

Throws:

NullArgumentException - priceScheduleQueryInspector is null

UnsupportedException - priceScheduleQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.