OSID Specifications
subscription rules package
Version 3.1.0
subscription rules package
Version 3.1.0
| Interface | osid.subscription.rules.DispatchEnablerQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidEnablerQueryInspector | ||
| Used By | osid.subscription.rules.DispatchEnablerSearchResults | ||
osid.subscription.rules.DispatchEnablerSmartPublisherSession | |||
| Description |
This is the query inspector for examining dispatch enabler queries. | ||
| Method | getRuledDispatchIdTerms | ||
| Description |
Gets the dispatch | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRuledDispatchTerms | ||
| Description |
Gets the dispatch query terms. | ||
| Return | osid.subscription.DispatchQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPublisherIdTerms | ||
| Description |
Gets the publisher | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPublisherTerms | ||
| Description |
Gets the publisher query terms. | ||
| Return | osid.subscription.PublisherQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchEnablerQueryInspectorRecord | ||
| Description |
Gets the dispatch enabler query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | dispatchEnablerRecordType | a dispatch enabler record type |
| Return | osid.subscription.rules.records.DispatchEnablerQueryInspectorRecord | the dispatch enabler query inspector record | |
| Errors | NULL_ARGUMENT | dispatchEnablerRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(dispatchEnablerRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |