OSID Specifications
acknowledgement package
Version 3.1.0
acknowledgement package
Version 3.1.0
| Interface | osid.acknowledgement.BillingQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Used By | osid.acknowledgement.BillingQueryInspector | ||
osid.acknowledgement.BillingSearchResults | |||
osid.acknowledgement.CreditQueryInspector | |||
| 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 | getCreditIdTerms | ||
| Description |
Gets the credit | ||
| Return | osid.search.terms.IdTerm[] | the credit Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCreditTerms | ||
| Description |
Gets the credit query terms. | ||
| Return | osid.acknowledgement.CreditQueryInspector[] | the credit terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorBillingIdTerms | ||
| Description |
Gets the ancestor billing | ||
| Return | osid.search.terms.IdTerm[] | the ancestor billing Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorBillingTerms | ||
| Description |
Gets the ancestor billing query terms. | ||
| Return | osid.acknowledgement.BillingQueryInspector[] | the ancestor billing terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantBillingIdTerms | ||
| Description |
Gets the descendant billing | ||
| Return | osid.search.terms.IdTerm[] | the descendant billing Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantBillingTerms | ||
| Description |
Gets the descendant billing query terms. | ||
| Return | osid.acknowledgement.BillingQueryInspector[] | the descendant billing terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBillingQueryInspectorRecord | ||
| Description |
Gets the record query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | billingRecordType | a billing record type |
| Return | osid.acknowledgement.records.BillingQueryInspectorRecord | the billing query inspector record | |
| Errors | NULL_ARGUMENT | billingRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(billingRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |