OSID Logo
OSID Specifications
financials budgeting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.budgeting.BudgetQueryInspector
Implementsosid.OsidRelationshipQueryInspector
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.

MethodgetActivityIdTerms
Description

Gets the activity Id query terms.

Returnosid.search.terms.IdTerm[]the activity Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetActivityTerms
Description

Gets the activity query terms.

Returnosid.financials.ActivityQueryInspector[]the activity query terms
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodIdTerms
Description

Gets the fiscal period Id query terms.

Returnosid.search.terms.IdTerm[]the fiscal period Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodTerms
Description

Gets the fiscal period query terms.

Returnosid.financials.FiscalPeriodQueryInspector[]the fiscal period query terms
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntryIdTerms
Description

Gets the budget entry Id query terms.

Returnosid.search.terms.IdTerm[]the budget entry Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntryTerms
Description

Gets the budget entry query terms.

Returnosid.financials.budgeting.BudgetEntryQueryInspector[]the budget entry query terms
CompliancemandatoryThis method must be implemented.
MethodgetBusinessIdTerms
Description

Gets the business Id query terms.

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

Gets the business query terms.

Returnosid.financials.BusinessQueryInspector[]the business query terms
CompliancemandatoryThis method must be implemented.
MethodgetBudgetQueryInspectorRecord
Description

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

Parametersosid.type.TypebudgetRecordTypea budget record type
Returnosid.financials.budgeting.records.BudgetQueryInspectorRecordthe budget query inspector record
ErrorsNULL_ARGUMENT budgetRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(budgetRecordType) is false
CompliancemandatoryThis method must be implemented.