OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.SubscriptionQueryInspector
Implementsosid.OsidRelationshipQueryInspector
Description

The query inspector for examining subscription queries.

MethodgetDispatchIdTerms
Description

Gets the dispatch Id terms.

Returnosid.search.terms.IdTerm[]the dispatch Id terms
CompliancemandatoryThis method must be implemented.
MethodgetDispatchTerms
Description

Gets the dispatch terms.

Returnosid.subscription.DispatchQueryInspector[]the dispatch terms
CompliancemandatoryThis method must be implemented.
MethodgetSubscriberIdTerms
Description

Gets the subscriber Id terms.

Returnosid.search.terms.IdTerm[]the resource Id terms
CompliancemandatoryThis method must be implemented.
MethodgetSubscriberTerms
Description

Gets the subscriber terms.

Returnosid.resource.ResourceQueryInspector[]the resource terms
CompliancemandatoryThis method must be implemented.
MethodgetAddressIdTerms
Description

Gets the address Id terms.

Returnosid.search.terms.IdTerm[]the address Id terms
CompliancemandatoryThis method must be implemented.
MethodgetAddressTerms
Description

Gets the address terms.

Returnosid.contact.AddressQueryInspector[]the address terms
CompliancemandatoryThis method must be implemented.
MethodgetPublisherIdTerms
Description

Gets the publisher Id terms.

Returnosid.search.terms.IdTerm[]the publisher Id terms
CompliancemandatoryThis method must be implemented.
MethodgetPublisherTerms
Description

Gets the publisher terms.

Returnosid.subscription.PublisherQueryInspector[]the publisher terms
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionQueryInspectorRecord
Description

Gets the subscription query inspector record corresponding to the given Subscription record Type.

Parametersosid.type.TypesubscriptionRecordTypea subscription record type
Returnosid.subscription.records.SubscriptionQueryInspectorRecordthe subscription query inspector record
ErrorsNULL_ARGUMENT subscriptionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(subscriptionRecordType) is false
CompliancemandatoryThis method must be implemented.