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.
Modifier and Type | Method and 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.
|
canSearchPriceSchedules, getPriceScheduleQuery, getPriceSchedulesByQuery, getStore, getStoreId, useFederatedStoreView, useIsolatedStoreView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PriceScheduleSearch getPriceScheduleSearch()
mandatory
- This method must be implemented. PriceScheduleSearchOrder getPriceScheduleSearchOrder()
PriceScheduleSearchOrder
is supplied to a
PriceScheduleSearch
to specify the ordering of results.mandatory
- This method must be implemented. PriceScheduleSearchResults getPriceSchedulesBySearch(PriceScheduleQuery priceScheduleQuery, PriceScheduleSearch priceScheduleSearch) throws OperationFailedException, PermissionDeniedException
priceScheduleQuery
- the price schedule querypriceScheduleSearch
- the price schedule searchNullArgumentException
- priceScheduleQuery
or priceScheduleSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- priceScheduleQuery
or priceScheduleSearch
is not of this
servicemandatory
- This method must be implemented. PriceScheduleQuery getPriceScheduleQueryFromInspector(PriceScheduleQueryInspector priceScheduleQueryInspector)
PriceScheduleSearchResults.
priceScheduleQueryInspector
- a query inspectorNullArgumentException
-
priceScheduleQueryInspector
is null
UnsupportedException
-
priceScheduleQueryInspector
is not of this servicemandatory
- This method must be implemented.