public interface OfferingConstrainerEnablerQuery extends OsidEnablerQuery
This is the query for searching offering constrainer 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 |
clearCatalogueIdTerms()
Clears the catalogue
Id query terms. |
void |
clearCatalogueTerms()
Clears the catalogue query terms.
|
void |
clearRuledOfferingConstrainerIdTerms()
Clears the offering constrainer
Id query terms. |
void |
clearRuledOfferingConstrainerTerms()
Clears the offering constrainer query terms.
|
CatalogueQuery |
getCatalogueQuery()
Gets the query for a catalogue.
|
OfferingConstrainerEnablerQueryRecord |
getOfferingConstrainerEnablerQueryRecord(Type offeringConstrainerEnablerRecordType)
Gets the offering constrainer enabler query record corresponding to
the given
OfferingConstrainerEnabler record
Type. |
OfferingConstrainerQuery |
getRuledOfferingConstrainerQuery()
Gets the query for an offering constrainer.
|
void |
matchAnyRuledOfferingConstrainer(boolean match)
Matches enablers mapped to any offering constrainer.
|
void |
matchCatalogueId(Id catalogueId,
boolean match)
Matches enablers mapped to the catalogue.
|
void |
matchRuledOfferingConstrainerId(Id offeringConstrainerId,
boolean match)
Matches enablers mapped to the offering constrainer.
|
boolean |
supportsCatalogueQuery()
Tests if a
CatalogueQuery is available. |
boolean |
supportsRuledOfferingConstrainerQuery()
Tests if an
OfferingConstrainerQuery 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 matchRuledOfferingConstrainerId(Id offeringConstrainerId, boolean match)
offeringConstrainerId
- the offering constrainer Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- offeringConstrainerId
is null
mandatory
- This method must be implemented. void clearRuledOfferingConstrainerIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledOfferingConstrainerQuery()
OfferingConstrainerQuery
is available. true
if an offering constrainer query is
available, false
otherwisemandatory
- This method must be implemented. OfferingConstrainerQuery getRuledOfferingConstrainerQuery()
OR
term.UnimplementedException
-
supportsRuledOfferingConstrainerQuery()
is
false
optional
- This method must be implemented if
supportsRuledOfferingConstrainerQuery()
is
true.
void matchAnyRuledOfferingConstrainer(boolean match)
match
- true
for enablers mapped to any offering
constrainer, false
to match enablers mapped to
no offering constrainersmandatory
- This method must be implemented. void clearRuledOfferingConstrainerTerms()
mandatory
- This method must be implemented. void matchCatalogueId(Id catalogueId, boolean match)
catalogueId
- the catalogue Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- catalogueId
is
null
mandatory
- This method must be implemented. void clearCatalogueIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsCatalogueQuery()
CatalogueQuery
is available. true
if a catalogue query is available,
false
otherwisemandatory
- This method must be implemented. CatalogueQuery getCatalogueQuery()
OR
term.UnimplementedException
-
supportsCatalogueQuery()
is false
optional
- This method must be implemented if
supportsCatalogueQuery()
is true.
void clearCatalogueTerms()
mandatory
- This method must be implemented. OfferingConstrainerEnablerQueryRecord getOfferingConstrainerEnablerQueryRecord(Type offeringConstrainerEnablerRecordType) throws OperationFailedException
OfferingConstrainerEnabler
record
Type.
Multiple record retrievals produce a nested OR
term.offeringConstrainerEnablerRecordType
- an offering constrainer
enabler record typeNullArgumentException
-
offeringConstrainerEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(offeringConstrainerEnablerRecordType)
is
false
mandatory
- This method must be implemented.