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

Interface	osid.financials.budgeting.BudgetSearchSession
Implements	`osid.financials.budgeting.BudgetQuerySession`
Used By	`osid.financials.budgeting.FinancialsBudgetingManager`
Used By	`osid.financials.budgeting.FinancialsBudgetingProxyManager`
Description	This session provides methods for searching among `Budgets`. The search query is constructed using the `BudgetQuery`. `getBudgetsByQuery()` is the basic search method and returns a list of `Budgets`. A more advanced search may be performed with `getBudgetsBySearch()` .It accepts a `BudgetSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getBudgetsBySearch()` returns a `BudgetSearchResults` that can be used to access the resulting `BudgetList` or be used to perform a search within the result set through `BudgetSearch` . This session defines views that offer differing behaviors for searching. federated business view: searches include budgets in businesses of which this business is an ancestor in the business hierarchy isolated business view: searches are restricted to budgets in this business Budgets may have a query record indicated by their respective record types. The queryrecord is accessed via the `BudgetQuery`.
Method	getBudgetSearch
Description	Gets a budget search.
Return	`osid.financials.budgeting.BudgetSearch`		the budget search
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetSearchOrder
Description	Gets a budget search order. The `BudgetSearchOrder` is supplied to a `BudgetSearch` to specify the ordering of results.
Return	`osid.financials.budgeting.BudgetSearchOrder`		the budget search order
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.financials.budgeting.BudgetQuery`	`budgetQuery`	the budget query
Parameters	`osid.financials.budgeting.BudgetSearch`	`budgetSearch`	the budget search
Return	`osid.financials.budgeting.BudgetSearchResults`		the budget search results
Errors	NULL_ARGUMENT		`budgetQuery` or `budgetSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`budgetQuery` or `budgetSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetQueryFromInspector
Description	Gets a budget query from an inspector. The inspector is available from a `BudgetSearchResults`.
Parameters	`osid.assessment.ItemQueryInspector`	`budgetQueryInspector`	a budget 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.