OSID - osid.financials.budgeting.BudgetSmartBusinessSession Service Interface Definition

Interface	osid.financials.budgeting.BudgetSmartBusinessSession
Implements	`osid.OsidSession`
Used By	`osid.financials.budgeting.FinancialsBudgetingManager`
Used By	`osid.financials.budgeting.FinancialsBudgetingProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `BudgetQuery` can be retrieved from this session and mapped to this `CoursOfferingeCatalog` to create a virtual collection of `Budgets`. The budgets may be sequenced using the `BudgetSearchOrder` from this session. This `Business` has a default query that matches any budget and a default search order that specifies no sequencing. The queries may be examined using a `BudgetQueryInspector`. The query may be modified by converting the inspector back to a `BudgetQuery` .
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.financials.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	getBudgetQuery
Description	Gets a budget query.
Return	`osid.financials.budgeting.BudgetQuery`		the budget query
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetSearchOrder
Description	Gets a budget search order.
Return	`osid.financials.budgeting.BudgetSearchOrder`		the budget search order
Compliance	`mandatory`		This method must be implemented.
Method	applyBudgetQuery
Description	Applies a budget query to this business.
Parameters	`osid.financials.budgeting.BudgetQuery`	`budgetQuery`	the budget query
Errors	NULL_ARGUMENT		`budgetQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`budgetQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectBudgetQuery
Description	Gets a budget query inspector for this business.
Return	`osid.financials.budgeting.BudgetQueryInspector`		the budget query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyBudgetSequencing
Description	Applies a budget search order to this business.
Parameters	`osid.financials.budgeting.BudgetSearchOrder`	`budgetSearchOrder`	the budget search order
Errors	NULL_ARGUMENT		`budgetSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`budgetSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetQueryFromInspector
Description	Gets a budget query from an inspector.
Parameters	`osid.financials.budgeting.BudgetQueryInspector`	`budgetQueryInspector`	a query inspector
Return	`osid.financials.budgeting.BudgetQuery`		the budget query
Errors	NULL_ARGUMENT		`budgetQueryInspector` is `null`
Errors	UNSUPPORTED		`budgetQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.