OSID Specifications
billing package
Version 3.1.0
billing package
Version 3.1.0
| Interface | osid.billing.PeriodQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
| Used By | osid.billing.BusinessQueryInspector | ||
osid.billing.EntryQueryInspector | |||
osid.billing.PeriodSearchResults | |||
osid.billing.PeriodSmartBusinessSession | |||
osid.billing.payment.PaymentQueryInspector | |||
| 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 | getDisplayLabelTerms | ||
| Description |
Gets the display label query terms. | ||
| Return | osid.search.terms.StringTerm[] | the display labelquery terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOpenDateTerms | ||
| Description |
Gets the open date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the open date query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCloseDateTerms | ||
| Description |
Gets the close date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the close date query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBillingDateTerms | ||
| Description |
Gets the billing date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the billing date query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDueDateTerms | ||
| Description |
Gets the dur date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the dur date 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.billing.BusinessQueryInspector[] | the business query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPeriodQueryInspectorRecord | ||
| Description |
Gets the period query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | periodRecordType | a period record type |
| Return | osid.billing.records.PeriodQueryInspectorRecord | the period query inspector record | |
| Errors | NULL_ARGUMENT | periodRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(periodRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |