OSID - osid.acknowledgement.CreditQuerySession Service Interface Definition

Interface	osid.acknowledgement.CreditQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.acknowledgement.CreditSearchSession`
Used By	`osid.acknowledgement.AcknowledgementManager`
Used By	`osid.acknowledgement.AcknowledgementProxyManager`
Description	This session provides methods for querying `Credit` objects. The search query is constructed using the `CreditQuery`. 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	getBillingId
Description	Gets the `Billing` `Id` associated with this session.
Return	`osid.id.Id`		the `Billing Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBilling
Description	Gets the `Billing` associated with this session.
Return	`osid.acknowledgement.Billing`		the billing
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchCredits
Description	Tests if this user can perform `Credit` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may wish not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedBillingView
Description	Federates the view for methods in this session. A federated view will include credits in billings which are children of this billing in the billing hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBillingView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this billing only.
Compliance	`mandatory`		This method is must be implemented.
Method	getCreditQuery
Description	Gets a credit query.
Return	`osid.acknowledgement.CreditQuery`		the credit query
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsByQuery
Description	Gets a list of credits matching the given credit query.
Parameters	`osid.acknowledgement.CreditQuery`	`creditQuery`	the credit query
Return	`osid.acknowledgement.CreditList`		the returned `CreditList`
Errors	NULL_ARGUMENT		`creditQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`creditQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.