OSID Logo
OSID Specifications
financials budgeting package
Version 3.1.0
Interfaceosid.financials.budgeting.BudgetEntryQueryInspector
Implementsosid.OsidRelationshipQueryInspector
Used Byosid.financials.budgeting.BudgetEntrySearchResults
osid.financials.budgeting.BudgetEntrySmartBusinessSession
osid.financials.budgeting.BudgetQueryInspector
Description

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to OsidQuery interfaces for reuse or modification in the search sessions.

Like all OsidQueryInspectors, BudgetEntryQueryInspector is stateful and must not be accessed by multiple processing threads.

MethodgetBudgetIdTerms
Description

Gets the budget Id query terms.

Returnosid.search.terms.IdTerm[] the v Id query terms
Compliancemandatory This method must be implemented.
MethodgetBudgetTerms
Description

Gets the budget query terms.

Returnosid.financials.budgeting.BudgetQueryInspector[] the budget query terms
Compliancemandatory This method must be implemented.
MethodgetAccountIdTerms
Description

Gets the account Id query terms.

Returnosid.search.terms.IdTerm[] the account Id query terms
Compliancemandatory This method must be implemented.
MethodgetAccountTerms
Description

Gets the account query terms.

Returnosid.financials.AccountQueryInspector[] the account query terms
Compliancemandatory This method must be implemented.
MethodgetAmountTerms
Description

Gets the amount query terms.

Returnosid.search.terms.CurrencyRangeTerm[] the date range query terms
Compliancemandatory This method must be implemented.
MethodgetDebitTerms
Description

Gets the debit query terms.

Returnosid.search.terms.BooleanTerm[] the debit query terms
Compliancemandatory This method must be implemented.
MethodgetBusinessIdTerms
Description

Gets the business Id query terms.

Returnosid.search.terms.IdTerm[] the business Id query terms
Compliancemandatory This method must be implemented.
MethodgetBusinessTerms
Description

Gets the business query terms.

Returnosid.financials.BusinessQueryInspector[] the business query terms
Compliancemandatory This method must be implemented.
MethodgetBudgetEntryQueryInspectorRecord
Description

Gets the budget entry query inspector record corresponding to the given BudgetEntry record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypebudgetEntryRecordType a budget entry record type
Returnosid.financials.budgeting.records.BudgetEntryQueryInspectorRecord the budget entry query inspector record
ErrorsNULL_ARGUMENT budgetEntryRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(budgetEntryRecordType) is false
Compliancemandatory This method must be implemented.