OSID - osid.offering.rules.OfferingConstrainerSearchSession Service Interface Definition

Interface	osid.offering.rules.OfferingConstrainerSearchSession
Implements	`osid.offering.rules.OfferingConstrainerQuerySession`
Description	This session provides methods for searching among `OfferingConstrainer` objects. The search query is constructed using the `OfferingConstraineryQuery.` `getOfferingConstrainersByQuery()` is the basic search method and returns a list of `OfferingConstrainers.` A more advanced search may be performed with `getOfferingConstrainersBySearch().` It accepts an `OfferingConstrainerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as offering. `getOfferingConstrainersBySearch()` returns an `OfferingConstrainerSearchResults` that can be used to access the resulting `OfferingConstrainerList` or be used to perform a search within the result set through `OfferingConstrainerSearch.` This session defines views that offer differing behaviors for searching. federated catalogue view: searches include offering constrainer in catalogues of which this catalogue is an ancestor in the catalogue hierarchy isolated catalogue view: searches are restricted to offering constrainer in this catalogue `OfferingConstrainers` may have a query record indicated by their respective record types. The query record is accessed via the `OfferingConstrainerQuery.`
Method	getOfferingConstrainerSearch
Description	Gets an offering constrainer search.
Return	`osid.offering.rules.OfferingConstrainerSearch`		the offering constrainer search
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingConstrainerSearchOrder
Description	Gets an offering constrainer search order. The `OfferingConstrainerSearchOrder` is supplied to an `OfferingConstrainerSearch` to specify the ordering of results.
Return	`osid.offering.rules.OfferingConstrainerSearchOrder`		the offering constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingConstrainersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.offering.rules.OfferingConstrainerQuery`	`offeringConstrainerQuery`	the offering constrainer query
Parameters	`osid.offering.rules.OfferingConstrainerSearch`	`offeringConstrainerSearch`	the offering constrainer search
Return	`osid.offering.rules.OfferingConstrainerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`offeringConstrainerQuery` or `offeringConstrainerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`offeringConstrainerQuery` or `offeringConstrainerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingConstrainerQueryFromInspector
Description	Gets an offering constrainer query from an inspector. The inspector is available from an `OfferingConstrainerSearchResults.`
Parameters	`osid.offering.rules.OfferingConstrainerQueryInspector`	`offeringConstrainerQueryInspector`	an offering constrainer query inspector
Return	`osid.offering.rules.OfferingConstrainerQuery`		the offering constrainer query
Errors	NULL_ARGUMENT		`offeringConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`offeringConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.