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

Interface	osid.financials.budgeting.BudgetEntrySmartBusinessSession
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. An `BudgetEntryQuery` can be retrieved from this session and mapped to this `Business` to create a virtual collection of `BudgetEntries`. The budget entries may be sequenced using the `BudgetEntrySearchOrder` from this session. This `Business` has a default query that matches any budget entry and a default search order that specifies no sequencing. The queries may be examined using an `BudgetEntryQueryInspector`. The query may be modified by converting the inspector back to an `BudgetEntryQuery`.
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	getBudgetEntryQuery
Description	Gets a budget entry query.
Return	`osid.financials.budgeting.BudgetEntryQuery`		the budget entry query
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetEntrySearchOrder
Description	Gets a budget entry search order.
Return	`osid.financials.budgeting.BudgetEntrySearchOrder`		the budget entry search order
Compliance	`mandatory`		This method must be implemented.
Method	applyBudgetEntryQuery
Description	Applies a budget entry query to this business.
Parameters	`osid.financials.budgeting.BudgetEntryQuery`	`budgetEntryQuery`	the budget entry query
Errors	NULL_ARGUMENT		`budgetEntryQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`budgetEntryQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectBudgetEntryQuery
Description	Gets a budget entry query inspector for this business.
Return	`osid.financials.budgeting.BudgetEntryQueryInspector`		the budget entry query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyBudgetEntrySequencing
Description	Applies a budget entry search order to this business.
Parameters	`osid.financials.budgeting.BudgetEntrySearchOrder`	`budgetEntrySearchOrder`	the budget entry search order
Errors	NULL_ARGUMENT		`budgetEntrySearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`budgetEntrySearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetEntryQueryFromInspector
Description	Gets a budget entry query from an inspector.
Parameters	`osid.financials.budgeting.BudgetEntryQueryInspector`	`budgetEntryQueryInspector`	a query inspector
Return	`osid.financials.budgeting.BudgetEntryQuery`		the budget entry query
Errors	NULL_ARGUMENT		`budgetEntryQueryInspector` is `null`
Errors	UNSUPPORTED		`budgetEntryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.