OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
financials package
Version 3.0.0
Release Candidate Preview
| Interface | osid.financials.BusinessQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| 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 query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAccountTerms | ||
| Description |
Gets the account query terms. | ||
| Return | osid.financials.AccountQueryInspector[] | the account query terms | |
| Compliance | mandatory | This method must be implemented. | |
| 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 | getAncestorBusinessIdTerms | ||
| Description |
Gets the ancestor business | ||
| Return | osid.search.terms.IdTerm[] | the ancestor business Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorBusinessTerms | ||
| Description |
Gets the ancestor business query terms. | ||
| Return | osid.financials.BusinessQueryInspector[] | the ancestor business terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantBusinessIdTerms | ||
| Description |
Gets the descendant business | ||
| Return | osid.search.terms.IdTerm[] | the descendant business Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantBusinessTerms | ||
| Description |
Gets the descendant business query terms. | ||
| Return | osid.financials.BusinessQueryInspector[] | the descendant business terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBusinessQueryInspectorRecord | ||
| Description |
Gets the business query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | businessRecordType | a business record type |
| Return | osid.financials.records.BusinessQueryInspectorRecord | the business query inspector record | |
| Errors | NULL_ARGUMENT | businessRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(businessRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |