OSID Logo
OSID Specifications
subscription rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.rules.SubscriptionEnablerQueryInspector
Implementsosid.OsidEnablerQueryInspector
Description

This is the query inspector for examining subscription enabler queries.

MethodgetRuledSubscriptionIdTerms
Description

Gets the subscription Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetRuledSubscriptionTerms
Description

Gets the subscription query terms.

Returnosid.subscription.SubscriptionQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetPublisherIdTerms
Description

Gets the publisher Id query terms.

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

Gets the publisher query terms.

Returnosid.subscription.PublisherQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionEnablerQueryInspectorRecord
Description

Gets the subscription enabler query inspector record corresponding to the given SubscriptionEnabler record Type.

Parametersosid.type.TypesubscriptionEnablerRecordTypea subscription enabler record type
Returnosid.subscription.rules.records.SubscriptionEnablerQueryInspectorRecordthe subscription enabler query inspector record
ErrorsNULL_ARGUMENT subscriptionEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(subscriptionEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.