public interface OfferingConstrainerQuery extends OsidConstrainerQuery
This is the query for searching offering constrainers. 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 |
clearConstrainResultOptionsTerms()
Clears the constrain result options query terms.
|
void |
clearConstrainSponsorsTerms()
Clears the constrain sponsors query terms.
|
void |
clearConstrainTimePeriodsTerms()
Clears the constrain time periods query terms.
|
void |
clearOverrideCodeTerms()
Clears the code override query terms.
|
void |
clearOverrideDescriptionTerms()
Clears the description override query terms.
|
void |
clearOverrideResultOptionsTerms()
Clears the result options override query terms.
|
void |
clearOverrideSponsorsTerms()
Clears the sponsors override query terms.
|
void |
clearOverrideTimePeriodsTerms()
Clears the time periods override query terms.
|
void |
clearOverrideTitleTerms()
Clears the title override query terms.
|
void |
clearRuledCanonicalUnitIdTerms()
Clears the canonical unit
Id query terms. |
void |
clearRuledCanonicalUnitTerms()
Clears the canonical unit query terms.
|
CatalogueQuery |
getCatalogueQuery()
Gets the query for a catalogue.
|
OfferingConstrainerQueryRecord |
getOfferingConstrainerQueryRecord(Type offeringConstrainerRecordType)
Gets the offering constrainer query record corresponding to the given
OfferingConstrainer record Type. |
CanonicalUnitQuery |
getRuledCanonicalUnitQuery()
Gets the query for a canonical unit.
|
void |
matchAnyConstrainResultOptions(boolean match)
Matches any constrain result options.
|
void |
matchAnyConstrainSponsors(boolean match)
Matches any constrain sponsors.
|
void |
matchAnyConstrainTimePeriods(boolean match)
Matches any constrain time periods.
|
void |
matchAnyOverrideCode(boolean match)
Matches any code override.
|
void |
matchAnyOverrideDescription(boolean match)
Matches any description override.
|
void |
matchAnyOverrideResultOptions(boolean match)
Matches any result options override.
|
void |
matchAnyOverrideSponsors(boolean match)
Matches any sponsors override.
|
void |
matchAnyOverrideTimePeriods(boolean match)
Matches any time periods override.
|
void |
matchAnyOverrideTitle(boolean match)
Matches any title override.
|
void |
matchAnyRuledCanonicalUnit(boolean match)
Matches rules mapped to any canonical unit.
|
void |
matchCatalogueId(Id catalogueId,
boolean match)
Matches mapped to the catalogue.
|
void |
matchConstrainResultOptions(boolean match)
Matches constrain result options.
|
void |
matchConstrainSponsors(boolean match)
Matches constrain sponsors.
|
void |
matchConstrainTimePeriods(boolean match)
Matches constrain time periods.
|
void |
matchOverrideCode(boolean match)
Matches code overrides.
|
void |
matchOverrideDescription(boolean match)
Matches description overrides.
|
void |
matchOverrideResultOptions(boolean match)
Matches result options overrides.
|
void |
matchOverrideSponsors(boolean match)
Matches result options overrides.
|
void |
matchOverrideTimePeriods(boolean match)
Matches time periods overrides.
|
void |
matchOverrideTitle(boolean match)
Matches title overrides.
|
void |
matchRuledCanonicalUnitId(Id canonicalUnitId,
boolean match)
Matches mapped to the canonical unit.
|
boolean |
supportsCatalogueQuery()
Tests if a
CatalogueQuery is available. |
boolean |
supportsRuledCanonicalUnitQuery()
Tests if an
CanonicalUnitQuery is available. |
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
void matchRuledCanonicalUnitId(Id canonicalUnitId, boolean match)
canonicalUnitId
- the canonical unit Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- canonicalUnitId
is null
mandatory
- This method must be implemented. void clearRuledCanonicalUnitIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledCanonicalUnitQuery()
CanonicalUnitQuery
is available. true
if a canonical unit query is available,
false
otherwisemandatory
- This method must be implemented. CanonicalUnitQuery getRuledCanonicalUnitQuery()
OR
term.UnimplementedException
-
supportsRuledCanonicalUnitQuery()
is false
optional
- This method must be implemented if
supportsRuledCanonicalUnitQuery()
is true.
void matchAnyRuledCanonicalUnit(boolean match)
match
- true
for mapped to any canonical unit,
false
to match mapped to no canonicalUnitmandatory
- This method must be implemented. void clearRuledCanonicalUnitTerms()
mandatory
- This method must be implemented. void matchOverrideDescription(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyOverrideDescription(boolean match)
match
- true
for any description override,
false
to match no description overridemandatory
- This method must be implemented. void clearOverrideDescriptionTerms()
mandatory
- This method must be implemented. void matchOverrideTitle(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyOverrideTitle(boolean match)
match
- true
for any title override, false
to match no title overridemandatory
- This method must be implemented. void clearOverrideTitleTerms()
mandatory
- This method must be implemented. void matchOverrideCode(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyOverrideCode(boolean match)
match
- true
for any code override, false
to match no code overridemandatory
- This method must be implemented. void clearOverrideCodeTerms()
mandatory
- This method must be implemented. void matchOverrideTimePeriods(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyOverrideTimePeriods(boolean match)
match
- true
for any time periods override,
false
to match no time periods overridemandatory
- This method must be implemented. void clearOverrideTimePeriodsTerms()
mandatory
- This method must be implemented. void matchConstrainTimePeriods(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyConstrainTimePeriods(boolean match)
match
- true
for any time periods constraints,
false
to match no time periods constraintsmandatory
- This method must be implemented. void clearConstrainTimePeriodsTerms()
mandatory
- This method must be implemented. void matchOverrideResultOptions(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyOverrideResultOptions(boolean match)
match
- true
for any result options override,
false
to match no result options overridemandatory
- This method must be implemented. void clearOverrideResultOptionsTerms()
mandatory
- This method must be implemented. void matchConstrainResultOptions(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyConstrainResultOptions(boolean match)
match
- true
for any result options constraints,
false
to match no result options constraintsmandatory
- This method must be implemented. void clearConstrainResultOptionsTerms()
mandatory
- This method must be implemented. void matchOverrideSponsors(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyOverrideSponsors(boolean match)
match
- true
for any sponsors override,
false
to match no sponsors overridemandatory
- This method must be implemented. void clearOverrideSponsorsTerms()
mandatory
- This method must be implemented. void matchConstrainSponsors(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyConstrainSponsors(boolean match)
match
- true
for any sponsors constraints,
false
to match no sponsors constraintsmandatory
- This method must be implemented. void clearConstrainSponsorsTerms()
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. OfferingConstrainerQueryRecord getOfferingConstrainerQueryRecord(Type offeringConstrainerRecordType) throws OperationFailedException
OfferingConstrainer
record Type.
Multiple record retrievals produce a nested OR
term.offeringConstrainerRecordType
- an offering constrainer record
typeNullArgumentException
-
offeringConstrainerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(offeringConstrainerRecordType)
is
false
mandatory
- This method must be implemented.