OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.PriceScheduleSearchSession
Implementsosid.ordering.PriceScheduleQuerySession
Description

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.

MethodgetPriceScheduleSearch
Description

Gets a price schedule search.

Returnosid.ordering.PriceScheduleSearchthe price search
CompliancemandatoryThis method must be implemented.
MethodgetPriceScheduleSearchOrder
Description

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

Returnosid.ordering.PriceScheduleSearchOrderthe price schedule search order
CompliancemandatoryThis method must be implemented.
MethodgetPriceSchedulesBySearch
Description

Gets the price schedule search results matching the given search.

Parametersosid.ordering.PriceScheduleQuerypriceScheduleQuerythe price schedule query
osid.ordering.PriceScheduleSearchpriceScheduleSearchthe price schedule search
Returnosid.ordering.PriceScheduleSearchResultsthe price schedule search results
ErrorsNULL_ARGUMENT priceScheduleQuery or priceScheduleSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED priceScheduleQuery or priceScheduleSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPriceScheduleQueryFromInspector
Description

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

Parametersosid.ordering.PriceScheduleQueryInspectorpriceScheduleQueryInspectora query inspector
Returnosid.ordering.PriceScheduleQuerythe price schedule query
ErrorsNULL_ARGUMENT priceScheduleQueryInspector is null
UNSUPPORTED priceScheduleQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.