OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
financials package
Version 3.0.0
Release Candidate Preview
| Interface | osid.financials.AccountQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidFederateableQueryInspector | |||
| 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 | getCreditBalanceTerms | ||
| Description |
Gets the credit balance query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the credit balance query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCodeTerms | ||
| Description |
Gets the code query terms. | ||
| Return | osid.search.terms.StringTerm[] | the code query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSummaryTerms | ||
| Description |
Gets the summary query terms. | ||
| Return | osid.financials.SummaryQueryInspector[] | the summary query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorAccountIdTerms | ||
| Description |
Gets the ancestor account | ||
| Return | osid.search.terms.IdTerm[] | the ancestor account Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorAccountTerms | ||
| Description |
Gets the ancestor account query terms. | ||
| Return | osid.financials.AccountQueryInspector[] | the ancestor account terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantAccountIdTerms | ||
| Description |
Gets the descendant account | ||
| Return | osid.search.terms.IdTerm[] | the descendant account Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantAccountTerms | ||
| Description |
Gets the descendant account query terms. | ||
| Return | osid.financials.AccountQueryInspector[] | the descendant account 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 | getAccountQueryInspectorRecord | ||
| Description |
Gets the account query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | accountRecordType | an account record type |
| Return | osid.financials.records.AccountQueryInspectorRecord | the account query inspector record | |
| Errors | NULL_ARGUMENT | accountRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(accountRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |