OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
subscription package
Version 3.0.0
Release Candidate Preview
| Interface | osid.subscription.PublisherQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining for publisher queries. | ||
| 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 | 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 | getAncestorPublisherIdTerms | ||
| Description |
Gets the ancestor publisher | ||
| Return | osid.search.terms.IdTerm[] | the ancestor publisher Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorPublisherTerms | ||
| Description |
Gets the ancestor publisher terms. | ||
| Return | osid.subscription.PublisherQueryInspector[] | the ancestor publisher terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantPublisherIdTerms | ||
| Description |
Gets the descendant publisher | ||
| Return | osid.search.terms.IdTerm[] | the descendant publisher Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantPublisherTerms | ||
| Description |
Gets the descendant publisher terms. | ||
| Return | osid.subscription.PublisherQueryInspector[] | the descendant publisher terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPublisherQueryInspectorRecord | ||
| Description |
Gets the publisher query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | publisherRecordType | a publisher record type |
| Return | osid.subscription.records.PublisherQueryInspectorRecord | the publisher query inspector record | |
| Errors | NULL_ARGUMENT | publisherRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(publisherRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |