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.BudgetEntrySearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getBudgetEntries | ||
| Description |
Gets the budget entry list resulting from a search. | ||
| Return | osid.financials.budgeting.BudgetEntryList | the budget entry list | |
| Errors | ILLEGAL_STATE | the budget entry list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBudgetEntryQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.financials.budgeting.BudgetEntryQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBudgetEntrySearchResultsRecord | ||
| Description |
Gets the budget entry search results record
corresponding to the given budget entry search record
| ||
| Parameters | osid.type.Type | budgetEntrySearchRecordType | a budget entry search record type |
| Return | osid.financials.budgeting.records.BudgetEntrySearchResultsRecord | the budget entry search results record | |
| Errors | NULL_ARGUMENT | budgetEntrySearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(budgetEntrySearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |