OSID Logo
OSID Specifications
subscription rules package
Version 3.1.0
Interfaceosid.subscription.rules.DispatchEnablerQueryInspector
Implementsosid.OsidEnablerQueryInspector
Used Byosid.subscription.rules.DispatchEnablerSearchResults
osid.subscription.rules.DispatchEnablerSmartPublisherSession
Description

This is the query inspector for examining dispatch enabler queries.

Like all OsidQueryInspectors, DispatchEnablerQueryInspector is stateful and must not be accessed by multiple processing threads.

MethodgetRuledDispatchIdTerms
Description

Gets the dispatch Id query terms.

Returnosid.search.terms.IdTerm[] the query terms
Compliancemandatory This method must be implemented.
MethodgetRuledDispatchTerms
Description

Gets the dispatch query terms.

Returnosid.subscription.DispatchQueryInspector[] the query terms
Compliancemandatory This method must be implemented.
MethodgetPublisherIdTerms
Description

Gets the publisher Id query terms.

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

Gets the publisher query terms.

Returnosid.subscription.PublisherQueryInspector[] the query terms
Compliancemandatory This method must be implemented.
MethodgetDispatchEnablerQueryInspectorRecord
Description

Gets the dispatch enabler query inspector record corresponding to the given DispatchEnabler record Type.

Parametersosid.type.TypedispatchEnablerRecordType a dispatch enabler record type
Returnosid.subscription.rules.records.DispatchEnablerQueryInspectorRecord the dispatch enabler query inspector record
ErrorsNULL_ARGUMENT dispatchEnablerRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(dispatchEnablerRecordType) is false
Compliancemandatory This method must be implemented.