OSID Specifications
financials budgeting package
Version 3.0.0
Release Candidate Preview
financials budgeting package
Version 3.0.0
Release Candidate Preview
| Interface | osid.financials.budgeting.BudgetSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getBudgets | ||
| Description |
Gets the budget list resulting from a search. | ||
| Return | osid.financials.budgeting.BudgetList | the budget list | |
| Errors | ILLEGAL_STATE | the budget list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBudgetQueryInspector | ||
| Description |
Gets the inspector for the query to examine the periods used in the search. | ||
| Return | osid.financials.budgeting.BudgetQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBudgetSearchResultsRecord | ||
| Description |
Gets the budget search results record corresponding to
the given budget search record | ||
| Parameters | osid.type.Type | budgetSearchRecordType | a budget search record type |
| Return | osid.financials.budgeting.records.BudgetSearchResultsRecord | the budget search results record | |
| Errors | NULL_ARGUMENT | budgetSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(budgetSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |