OSID Logo
OSID Specifications
financials budgeting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.budgeting.BudgetEntrySearchSession
Implementsosid.financials.budgeting.BudgetEntryQuerySession
Description

This session provides methods for searching among BudgetEntry objects. The search query is constructed using the BudgetEntryQuery.

getBudgetEntriesByQuery() is the basic search method and returns a list of BudgetEntrys. A more advanced search may be performed with getBudgetEntrysBySearch(). It accepts an BudgetEntrySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBudgetEntriesBySearch() returns an BudgetEntrySearchResults that can be used to access the resulting BudgetEntryList or be used to perform a search within the result set through BudgetEntrySearch.

This session defines views that offer differing behaviors for searching.

  • federated business view: searches include budget entries in businesses of which this business is an ancestor in the business hierarchy
  • isolated business view: searches are restricted to budget entries in this business

BudgetBudget Entries may have a query record indicated by their respective record types. The query record is accessed via the BudgetEntryQuery.

MethodgetBudgetEntrySearch
Description

Gets a budget entry search.

Returnosid.financials.budgeting.BudgetEntrySearchthe budget entry search
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntrySearchOrder
Description

Gets a budget entry search order. The BudgetEntrySearchOrder is supplied to an BudgetEntrySearch to specify the ordering of results.

Returnosid.financials.budgeting.BudgetEntrySearchOrderthe budget entry search order
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntriesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.financials.budgeting.BudgetEntryQuerybudgetEntryQuerythe budget entry query
osid.financials.budgeting.BudgetEntrySearchbudgetEntrySearchthe budget entry search
Returnosid.financials.budgeting.BudgetEntrySearchResultsthe budget entry search results
ErrorsNULL_ARGUMENT budgetEntryQuery or budgetEntrySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED budgetEntryQuery or budgetEntrySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntryQueryFromInspector
Description

Gets a budget entry query from an inspector. The inspector is available from an BudgetEntrySearchResults.

Parametersosid.financials.budgeting.BudgetEntryQueryInspectorbudgetEntryQueryInspectora budget entry query inspector
Returnosid.financials.budgeting.BudgetEntryQuerythe budget entry query
ErrorsNULL_ARGUMENT budgetEntryQueryInspector is null
UNSUPPORTED budgetEntryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.