OSID - osid.billing.CustomerSmartBusinessSession Service Interface Definition

Interface	osid.billing.CustomerSmartBusinessSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `CustomerQuery` can be retrieved from this session and mapped to this `Business` to create a virtual collection of `Customers.` The customers may be sequenced using the `CustomerSearchOrder` from this session. This `Business` has a default query that matches any customer and a default search order that specifies no sequencing. The queries may be examined using a `CustomerQueryInspector.` The query may be modified by converting the inspector back to a `CustomerQuery.`
Method	getBusinessId
Description	Gets the `Business` `Id` associated with this session.
Return	`osid.id.Id`		the `Business Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBusiness
Description	Gets the `Business` associated with this session.
Return	`osid.billing.Business`		the business
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartBusinesses
Description	Tests if this user can manage smart businesses. A return of true does not guarantee successful assessment. A return of false indicates that it is known methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart business management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerQuery
Description	Gets a customer query.
Return	`osid.billing.CustomerQuery`		the customer query
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerSearchOrder
Description	Gets a customer search order.
Return	`osid.billing.CustomerSearchOrder`		the customer search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCustomerQuery
Description	Applies a customer query to this business.
Parameters	`osid.billing.CustomerQuery`	`customerQuery`	the customer query
Errors	NULL_ARGUMENT		`customerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`customerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCustomerQuery
Description	Gets a customer query inspector for this business.
Return	`osid.billing.CustomerQueryInspector`		the customer query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCustomerSequencing
Description	Applies a customer search order to this business.
Parameters	`osid.billing.CustomerSearchOrder`	`customerSearchOrder`	the customer search order
Errors	NULL_ARGUMENT		`customerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`customerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerQueryFromInspector
Description	Gets a customer query from an inspector.
Parameters	`osid.billing.CustomerQueryInspector`	`customerQueryInspector`	a query inspector
Return	`osid.billing.CustomerQuery`		the customer query
Errors	NULL_ARGUMENT		`customerQueryInspector` is `null`
Errors	UNSUPPORTED		`customerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.