Interface | osid.financials.budgeting.BudgetEntrySearchSession | ||
---|---|---|---|
Implements | osid.financials.budgeting.BudgetEntryQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
BudgetBudget Entries may have a query record indicated by
their respective record types. The query record is accessed
via the | ||
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 | ||
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 |
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 | ||
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 | |
UNSUPPORTED | budgetEntryQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |