OSID - osid.ordering.PriceScheduleSearchSession Service Interface Definition

Interface	osid.ordering.PriceScheduleSearchSession
Implements	`osid.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.
Method	getPriceScheduleSearch
Description	Gets a price schedule search.
Return	`osid.ordering.PriceScheduleSearch`		the price search
Compliance	`mandatory`		This method must be implemented.
Method	getPriceScheduleSearchOrder
Description	Gets a price schedule search order. The `PriceScheduleSearchOrder` is supplied to a `PriceScheduleSearch` to specify the ordering of results.
Return	`osid.ordering.PriceScheduleSearchOrder`		the price schedule search order
Compliance	`mandatory`		This method must be implemented.
Method	getPriceSchedulesBySearch
Description	Gets the price schedule search results matching the given search.
Parameters	`osid.ordering.PriceScheduleQuery`	`priceScheduleQuery`	the price schedule query
Parameters	`osid.ordering.PriceScheduleSearch`	`priceScheduleSearch`	the price schedule search
Return	`osid.ordering.PriceScheduleSearchResults`		the price schedule search results
Errors	NULL_ARGUMENT		`priceScheduleQuery` or `priceScheduleSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`priceScheduleQuery` or `priceScheduleSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPriceScheduleQueryFromInspector
Description	Gets a price schedule query from an inspector. The inspector is available from a `PriceScheduleSearchResults.`
Parameters	`osid.ordering.PriceScheduleQueryInspector`	`priceScheduleQueryInspector`	a query inspector
Return	`osid.ordering.PriceScheduleQuery`		the price schedule query
Errors	NULL_ARGUMENT		`priceScheduleQueryInspector` is `null`
Errors	UNSUPPORTED		`priceScheduleQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.