org.osid.subscription.rules

Interface SubscriptionEnablerQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidEnablerQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector, OsidTemporalQueryInspector

public interface SubscriptionEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining subscription enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getPublisherIdTerms() Gets the publisher Id query terms.
PublisherQueryInspector[]	getPublisherTerms() Gets the publisher query terms.
IdTerm[]	getRuledSubscriptionIdTerms() Gets the subscription Id query terms.
SubscriptionQueryInspector[]	getRuledSubscriptionTerms() Gets the subscription query terms.
SubscriptionEnablerQueryInspectorRecord	getSubscriptionEnablerQueryInspectorRecord(Type subscriptionEnablerRecordType) Gets the subscription enabler query inspector record corresponding to the given SubscriptionEnabler record Type.

Methods inherited from interface org.osid.OsidEnablerQueryInspector

getCyclicEventIdTerms, getCyclicEventTerms, getDemographicIdTerms, getDemographicTerms, getEventIdTerms, getEventTerms, getScheduleIdTerms, getScheduleTerms

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getRuledSubscriptionIdTerms

IdTerm[] getRuledSubscriptionIdTerms()

Gets the subscription Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledSubscriptionTerms

SubscriptionQueryInspector[] getRuledSubscriptionTerms()

Gets the subscription query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPublisherIdTerms

IdTerm[] getPublisherIdTerms()

Gets the publisher Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPublisherTerms

PublisherQueryInspector[] getPublisherTerms()

Gets the publisher query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSubscriptionEnablerQueryInspectorRecord

SubscriptionEnablerQueryInspectorRecord getSubscriptionEnablerQueryInspectorRecord(Type subscriptionEnablerRecordType)
                                                                                   throws OperationFailedException

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

Parameters:

subscriptionEnablerRecordType - a subscription enabler record type

Returns:

the subscription enabler query inspector record

Throws:

NullArgumentException - subscriptionEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(subscriptionEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.