OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
financials package
Version 3.0.0
Release Candidate Preview
| Interface | osid.financials.SummaryQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCompendiumQueryInspector | ||
| 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 | getAccountIdTerms | ||
| Description |
Gets the account | ||
| Return | osid.search.terms.IdTerm[] | the account Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAccountTerms | ||
| Description |
Gets the account query terms. | ||
| Return | osid.financials.AccountQueryInspector[] | the account 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 | getCreditsTerms | ||
| Description |
Gets the credits query terms. | ||
| Return | osid.search.terms.CurrencyRangeTerm[] | the credits query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDebitsTerms | ||
| Description |
Gets the debits query terms. | ||
| Return | osid.search.terms.CurrencyRangeTerm[] | the debits query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBalanceTerms | ||
| Description |
Gets the balacnce query terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the balance query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBudgetTerms | ||
| Description |
Gets the budget query terms. | ||
| Return | osid.search.terms.CurrencyRangeTerm[] | the budget query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDeltaTerms | ||
| Description |
Gets the delta query terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the delta query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getForecastTerms | ||
| Description |
Gets the forecast query terms. | ||
| Return | osid.search.terms.CurrencyRangeTerm[] | the forecast query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSummaryQueryInspectorRecord | ||
| Description |
Gets the summary query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | summaryRecordType | a summary record type |
| Return | osid.financials.records.SummaryQueryInspectorRecord | the summary query inspector record | |
| Errors | NULL_ARGUMENT | summaryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(summaryRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |