OSID - osid.billing.PeriodSmartBusinessSession Service Interface Definition

Interface	osid.billing.PeriodSmartBusinessSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `PeriodQuery` can be retrieved from this session and mapped to this `Business` to create a virtual collection of `Periods.` The periods may be sequenced using the `PeriodSearchOrder` from this session. This `Business` has a default query that matches any period and a default search order that specifies no sequencing. The queries may be examined using a `PeriodQueryInspector.` The query may be modified by converting the inspector back to a `PeriodQuery.`
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	getPeriodQuery
Description	Gets a period query.
Return	`osid.billing.PeriodQuery`		the period query
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodSearchOrder
Description	Gets a period search order.
Return	`osid.billing.PeriodSearchOrder`		the period search order
Compliance	`mandatory`		This method must be implemented.
Method	applyPeriodQuery
Description	Applies a period query to this business.
Parameters	`osid.billing.PeriodQuery`	`periodQuery`	the period query
Errors	NULL_ARGUMENT		`periodQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`periodQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectPeriodQuery
Description	Gets a period query inspector for this business.
Return	`osid.billing.PeriodQueryInspector`		the period query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyPeriodSequencing
Description	Applies a period search order to this business.
Parameters	`osid.billing.PeriodSearchOrder`	`periodSearchOrder`	the period search order
Errors	NULL_ARGUMENT		`periodSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`periodSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodQueryFromInspector
Description	Gets a period query from an inspector.
Parameters	`osid.billing.PeriodQueryInspector`	`periodQueryInspector`	a query inspector
Return	`osid.billing.PeriodQuery`		the period query
Errors	NULL_ARGUMENT		`periodQueryInspector` is `null`
Errors	UNSUPPORTED		`periodQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.