org.osid.subscription.rules

Interface SubscriptionEnablerQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidEnablerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, OsidTemporalQuery, Suppliable

public interface SubscriptionEnablerQuery
extends OsidEnablerQuery

This is the query for searching subscription enablers. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearPublisherIdTerms() Clears the publisher Id query terms.
void	clearPublisherTerms() Clears the publisher query terms.
void	clearRuledSubscriptionIdTerms() Clears the subscription Id query terms.
void	clearRuledSubscriptionTerms() Clears the subscription query terms.
PublisherQuery	getPublisherQuery() Gets the query for a publisher.
SubscriptionQuery	getRuledSubscriptionQuery() Gets the query for a subscription.
SubscriptionEnablerQueryRecord	getSubscriptionEnablerQueryRecord(Type subscriptionEnablerRecordType) Gets the subscription enabler query record corresponding to the given SubscriptionEnabler record Type.
void	matchAnyRuledSubscription(boolean match) Matches enablers mapped to any subscription.
void	matchPublisherId(Id publisherId, boolean match) Matches enablers mapped to the publisher.
void	matchRuledSubscriptionId(Id subscriptionId, boolean match) Matches enablers mapped to the subscription.
boolean	supportsPublisherQuery() Tests if a PublisherQuery is available.
boolean	supportsRuledSubscriptionQuery() Tests if a SubscriptionQuery is available.

Methods inherited from interface org.osid.OsidEnablerQuery

clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchRuledSubscriptionId

void matchRuledSubscriptionId(Id subscriptionId,
                            boolean match)

Matches enablers mapped to the subscription.

Parameters:

subscriptionId - the subscription Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - subscriptionId is null

Compliance:

mandatory - This method must be implemented.

clearRuledSubscriptionIdTerms

void clearRuledSubscriptionIdTerms()

Clears the subscription Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledSubscriptionQuery

boolean supportsRuledSubscriptionQuery()

Tests if a SubscriptionQuery is available.

Returns:

true if a subscription query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledSubscriptionQuery

SubscriptionQuery getRuledSubscriptionQuery()

Gets the query for a subscription. Multiple retrievals produce a nested OR term.

Returns:

the subscription query

Throws:

UnimplementedException - supportsRuledSubscriptionQuery() is false

Compliance:

optional - This method must be implemented if supportsRuledSubscriptionQuery() is true.

matchAnyRuledSubscription

void matchAnyRuledSubscription(boolean match)

Matches enablers mapped to any subscription.

Parameters:

match - true for enablers mapped to any subscription, false to match enablers mapped to no subscription

Compliance:

mandatory - This method must be implemented.

clearRuledSubscriptionTerms

void clearRuledSubscriptionTerms()

Clears the subscription query terms.

Compliance:

mandatory - This method must be implemented.

matchPublisherId

void matchPublisherId(Id publisherId,
                    boolean match)

Matches enablers mapped to the publisher.

Parameters:

publisherId - the publisher Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - publisherId is null

Compliance:

mandatory - This method must be implemented.

clearPublisherIdTerms

void clearPublisherIdTerms()

Clears the publisher Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsPublisherQuery

boolean supportsPublisherQuery()

Tests if a PublisherQuery is available.

Returns:

true if a publisher query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPublisherQuery

PublisherQuery getPublisherQuery()

Gets the query for a publisher. Multiple retrievals produce a nested OR term.

Returns:

the publisher query

Throws:

UnimplementedException - supportsPublisherQuery() is false

Compliance:

optional - This method must be implemented if supportsPublisherQuery() is true.

clearPublisherTerms

void clearPublisherTerms()

Clears the publisher query terms.

Compliance:

mandatory - This method must be implemented.

getSubscriptionEnablerQueryRecord

SubscriptionEnablerQueryRecord getSubscriptionEnablerQueryRecord(Type subscriptionEnablerRecordType)
                                                                 throws OperationFailedException

Gets the subscription enabler query record corresponding to the given SubscriptionEnabler record Type. Multiple record retrievals produce a nested OR term.

Parameters:

subscriptionEnablerRecordType - a subscription enabler record type

Returns:

the subscription enabler query record

Throws:

NullArgumentException - subscriptionEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(subscriptionEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.