OSID Logo
OSID Specifications
financials budgeting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.budgeting.BudgetEntrySearch
Implementsosid.OsidSearch
Description

The search interface for governing budget entry searches.

MethodsearchAmongBudgetEntries
Description

Execute this search among the given list of budget entries.

Parametersosid.id.IdListbudgetEntryIdslist of entries
ErrorsNULL_ARGUMENT budgetEntryIds is null
CompliancemandatoryThis method must be implemented.
MethodorderBudgetEntryResults
Description

Specify an ordering to the search results.

Parametersosid.financials.budgeting.BudgetEntrySearchOrderbudgetEntrySearchOrderbudget entry search order
ErrorsNULL_ARGUMENT budgetEntrySearchOrder is null
UNSUPPORTED budgetEntrySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntrySearchRecord
Description

Gets the budget entry search record corresponding to the given budget entry search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypebudgetEntrySearchRecordTypea budget entry search record type
Returnosid.financials.budgeting.records.BudgetEntrySearchRecordthe budget entry search record
ErrorsNULL_ARGUMENT budgetEntrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(budgetEntrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.