OSID - osid.acknowledgement.CreditSearchSession Service Interface Definition

Interface	osid.acknowledgement.CreditSearchSession
Implements	`osid.acknowledgement.CreditQuerySession`
Used By	`osid.acknowledgement.AcknowledgementManager`
Used By	`osid.acknowledgement.AcknowledgementProxyManager`
Description	This session provides methods for searching `Credit` objects. The search query is constructed using the `CreditQuery`. The credit record `Type` also specifies the record for the credit query. `getCreditsByQuery()` is the basic search method and returns a list of `Credit` elements. A more advanced search may be performed with `getCreditsBySearch()`. It accepts a `CreditSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCreditsBySearch()` returns a `CreditSearchResults` that can be used to access the resulting `CreditList` or be used to perform a search within the result set through `CreditSearch`. This session defines views that offer differing behaviors for searching. federated billing view: searches include credits in billings of which this billing is a ancestor in the billing hierarchy isolated billing view: searches are restricted to credits in this billing Credits may have a query record indicated by their respective record types. The query record is accessed via the `CreditQuery`. The returns in this session may not be cast directly to these interfaces.
Method	getCreditSearch
Description	Gets a credit search.
Return	`osid.acknowledgement.CreditSearch`		the credit search
Compliance	`mandatory`		This method must be implemented.
Method	getCreditSearchOrder
Description	Gets a credit search order. The `CreditSearchOrder` is supplied to a `CreditSearch` to specify the ordering of results.
Return	`osid.acknowledgement.CreditSearchOrder`		the credit search order
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.acknowledgement.CreditQuery`	`creditQuery`	the credit query
Parameters	`osid.acknowledgement.CreditSearch`	`creditSearch`	the credit search
Return	`osid.acknowledgement.CreditSearchResults`		the search results
Errors	NULL_ARGUMENT		`creditQuery` or `creditSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`creditQuery` or `creditSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCreditQueryFromInspector
Description	Gets a credit query from an inspector. The inspector is available from a `CreditSearchResults`.
Parameters	`osid.acknowledgement.CreditQueryInspector`	`creditQueryInspector`	a credit query inspector
Return	`osid.acknowledgement.CreditQuery`		the credit query
Errors	NULL_ARGUMENT		`creditQueryInspector` is `null`
Errors	UNSUPPORTED		`creditQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.