Interface | osid.financials.budgeting.BudgetSearchSession | ||
---|---|---|---|
Implements | osid.financials.budgeting.BudgetQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Budgets may have a query record indicated by their
respective record types. The queryrecord is accessed via the
| ||
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 | ||
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 |
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 | ||
Parameters | osid.assessment.ItemQueryInspector | budgetQueryInspector | a budget query inspector |
Return | osid.financials.budgeting.BudgetQuery | the budget query | |
Errors | NULL_ARGUMENT | budgetQueryInspector is null | |
UNSUPPORTED | budgetQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |