OSID Specifications
subscription package
Version 3.1.0
subscription package
Version 3.1.0
| Interface | osid.subscription.DispatchQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidGovernatorQueryInspector | ||
| Used By | osid.subscription.DispatchSearchResults | ||
osid.subscription.DispatchSmartPublisherSession | |||
osid.subscription.PublisherQueryInspector | |||
osid.subscription.SubscriptionQueryInspector | |||
osid.subscription.rules.DispatchConstrainerQueryInspector | |||
osid.subscription.rules.DispatchEnablerQueryInspector | |||
osid.subscription.rules.DispatchProcessorQueryInspector | |||
| Description |
This is the query inspector for examining for dispatch queries. | ||
| Method | getEditorIdTerms | ||
| Description |
Gets the editor | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEditorTerms | ||
| Description |
Gets the editor query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAddressGenusTypeTerms | ||
| Description |
Gets the address genus | ||
| Return | osid.search.terms.TypeTerm[] | the address genus Type terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubscriptionIdTerms | ||
| Description |
Gets the subscription | ||
| Return | osid.search.terms.IdTerm[] | the subscription Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubscriptionTerms | ||
| Description |
Gets the subscription terms. | ||
| Return | osid.subscription.SubscriptionQueryInspector[] | the subscription terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPublisherIdTerms | ||
| Description |
Gets the publisher | ||
| Return | osid.search.terms.IdTerm[] | the publisher Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPublisherTerms | ||
| Description |
Gets the publisher terms. | ||
| Return | osid.subscription.PublisherQueryInspector[] | the publisher terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchQueryInspectorRecord | ||
| Description |
Gets the dispatch query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | dispatchRecordType | a dispatch record type |
| Return | osid.subscription.records.DispatchQueryInspectorRecord | the dispatch query inspector record | |
| Errors | NULL_ARGUMENT | dispatchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(dispatchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |