OSID Specifications
subscription package
Version 3.1.0
subscription package
Version 3.1.0
| Interface | osid.subscription.SubscriptionQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Used By | osid.subscription.DispatchQueryInspector | ||
osid.subscription.PublisherQueryInspector | |||
osid.subscription.SubscriptionSearchResults | |||
osid.subscription.SubscriptionSmartPublisherSession | |||
osid.subscription.rules.SubscriptionEnablerQueryInspector | |||
| Description |
The query inspector for examining subscription queries. | ||
| Method | getDispatchIdTerms | ||
| Description |
Gets the dispatch | ||
| Return | osid.search.terms.IdTerm[] | the dispatch Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDispatchTerms | ||
| Description |
Gets the dispatch terms. | ||
| Return | osid.subscription.DispatchQueryInspector[] | the dispatch terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubscriberIdTerms | ||
| Description |
Gets the subscriber | ||
| Return | osid.search.terms.IdTerm[] | the resource Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubscriberTerms | ||
| Description |
Gets the subscriber terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the resource terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAddressIdTerms | ||
| Description |
Gets the address | ||
| Return | osid.search.terms.IdTerm[] | the address Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAddressTerms | ||
| Description |
Gets the address terms. | ||
| Return | osid.contact.AddressQueryInspector[] | the address 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 | getSubscriptionQueryInspectorRecord | ||
| Description |
Gets the subscription query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | subscriptionRecordType | a subscription record type |
| Return | osid.subscription.records.SubscriptionQueryInspectorRecord | the subscription query inspector record | |
| Errors | NULL_ARGUMENT | subscriptionRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(subscriptionRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |