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.
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. |
clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchRuledSubscriptionId(Id subscriptionId, boolean match)
subscriptionId
- the subscription Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- subscriptionId
is null
mandatory
- This method must be implemented. void clearRuledSubscriptionIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledSubscriptionQuery()
SubscriptionQuery
is available. true
if a subscription query is available,
false
otherwisemandatory
- This method must be implemented. SubscriptionQuery getRuledSubscriptionQuery()
OR
term.UnimplementedException
-
supportsRuledSubscriptionQuery()
is false
optional
- This method must be implemented if
supportsRuledSubscriptionQuery()
is true.
void matchAnyRuledSubscription(boolean match)
match
- true
for enablers mapped to any
subscription, false
to match enablers mapped to
no subscriptionmandatory
- This method must be implemented. void clearRuledSubscriptionTerms()
mandatory
- This method must be implemented. void matchPublisherId(Id publisherId, boolean match)
publisherId
- the publisher Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- publisherId
is
null
mandatory
- This method must be implemented. void clearPublisherIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsPublisherQuery()
PublisherQuery
is available. true
if a publisher query is available,
false
otherwisemandatory
- This method must be implemented. PublisherQuery getPublisherQuery()
OR
term.UnimplementedException
-
supportsPublisherQuery()
is false
optional
- This method must be implemented if
supportsPublisherQuery()
is true.
void clearPublisherTerms()
mandatory
- This method must be implemented. SubscriptionEnablerQueryRecord getSubscriptionEnablerQueryRecord(Type subscriptionEnablerRecordType) throws OperationFailedException
SubscriptionEnabler
record Type.
Multiple record retrievals produce a nested OR
term.subscriptionEnablerRecordType
- a subscription enabler record
typeNullArgumentException
-
subscriptionEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(subscriptionEnablerRecordType)
is
false
mandatory
- This method must be implemented.