OSID Specifications
financials budgeting package
Version 3.1.0
financials budgeting package
Version 3.1.0
| Interface | osid.financials.budgeting.BudgetQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Used By | osid.financials.budgeting.BudgetEntryQueryInspector | ||
osid.financials.budgeting.BudgetSearchResults | |||
osid.financials.budgeting.BudgetSmartBusinessSession | |||
| 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
| ||
| Method | getActivityIdTerms | ||
| Description |
Gets the activity | ||
| Return | osid.search.terms.IdTerm[] | the activity Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActivityTerms | ||
| Description |
Gets the activity query terms. | ||
| Return | osid.financials.ActivityQueryInspector[] | the activity query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFiscalPeriodIdTerms | ||
| Description |
Gets the fiscal period | ||
| Return | osid.search.terms.IdTerm[] | the fiscal period Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFiscalPeriodTerms | ||
| Description |
Gets the fiscal period query terms. | ||
| Return | osid.financials.FiscalPeriodQueryInspector[] | the fiscal period query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBudgetEntryIdTerms | ||
| Description |
Gets the budget entry | ||
| Return | osid.search.terms.IdTerm[] | the budget entry Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBudgetEntryTerms | ||
| Description |
Gets the budget entry query terms. | ||
| Return | osid.financials.budgeting.BudgetEntryQueryInspector[] | the budget entry query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBusinessIdTerms | ||
| Description |
Gets the business | ||
| Return | osid.search.terms.IdTerm[] | the business Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBusinessTerms | ||
| Description |
Gets the business query terms. | ||
| Return | osid.financials.BusinessQueryInspector[] | the business query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBudgetQueryInspectorRecord | ||
| Description |
Gets the budget query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | budgetRecordType | a budget record type |
| Return | osid.financials.budgeting.records.BudgetQueryInspectorRecord | the budget query inspector record | |
| Errors | NULL_ARGUMENT | budgetRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(budgetRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |