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

Interface	osid.financials.budgeting.BudgetEntrySearchSession
Implements	`osid.financials.budgeting.BudgetEntryQuerySession`
Used By	`osid.financials.budgeting.FinancialsBudgetingManager`
Used By	`osid.financials.budgeting.FinancialsBudgetingProxyManager`
Description	This session provides methods for searching among `BudgetEntries`. The search query is constructed using the `BudgetEntryQuery`. `getBudgetEntriesByQuery()` is the basic search method and returns a list of `BudgetEntrys`. A more advanced search may be performed with `getBudgetEntrysBySearch()`.It accepts an `BudgetEntrySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getBudgetEntriesBySearch()` returns an `BudgetEntrySearchResults` that can be used to access the resulting `BudgetEntryList` or be used to perform a search within the result set through `BudgetEntrySearch`. This session defines views that offer differing behaviors for searching. federated business view: searches include budget entries in businesses of which this business is an ancestor in the business hierarchy isolated business view: searches are restricted to budget entries in this business BudgetBudget Entries may have a query record indicated by their respective record types. The query record is accessed via the `BudgetEntryQuery`.
Method	getBudgetEntrySearch
Description	Gets a budget entry search.
Return	`osid.financials.budgeting.BudgetEntrySearch`		the budget entry search
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetEntrySearchOrder
Description	Gets a budget entry search order. The `BudgetEntrySearchOrder` is supplied to an `BudgetEntrySearch` to specify the ordering of results.
Return	`osid.financials.budgeting.BudgetEntrySearchOrder`		the budget entry search order
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetEntriesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.financials.budgeting.BudgetEntryQuery`	`budgetEntryQuery`	the budget entry query
Parameters	`osid.financials.budgeting.BudgetEntrySearch`	`budgetEntrySearch`	the budget entry search
Return	`osid.financials.budgeting.BudgetEntrySearchResults`		the budget entry search results
Errors	NULL_ARGUMENT		`budgetEntryQuery` or `budgetEntrySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`budgetEntryQuery` or `budgetEntrySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetEntryQueryFromInspector
Description	Gets a budget entry query from an inspector. The inspector is available from an `BudgetEntrySearchResults`.
Parameters	`osid.financials.budgeting.BudgetEntryQueryInspector`	`budgetEntryQueryInspector`	a budget entry 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.