OSID Specifications
financials posting package
Version 3.0.0
Release Candidate Preview
financials posting package
Version 3.0.0
Release Candidate Preview
| Interface | osid.financials.posting.PostEntryQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidSubjugateableQueryInspector | |||
| 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 | getPostIdTerms | ||
| Description |
Gets the post | ||
| Return | osid.search.terms.IdTerm[] | the post Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostTerms | ||
| Description |
Gets the post query terms. | ||
| Return | osid.financials.posting.PostQueryInspector[] | the post query terms | |
| Compliance | mandatory | This method must be implemented. | |
| 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 | getAmountTerms | ||
| Description |
Gets the amount query terms. | ||
| Return | osid.search.terms.CurrencyRangeTerm[] | the date range query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDebitTerms | ||
| Description |
Gets the debit query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the debit 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 | getPostEntryQueryInspectorRecord | ||
| Description |
Gets the post entry query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | postEntryRecordType | a post entry record type |
| Return | osid.financials.posting.records.PostEntryQueryInspectorRecord | the post entry query inspector record | |
| Errors | NULL_ARGUMENT | postEntryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(postEntryRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |