org.osid.offering.rules

Interface CanonicalUnitEnablerQuery

All Superinterfaces:

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

public interface CanonicalUnitEnablerQuery
extends OsidEnablerQuery

This is the query for searching canonical unit 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	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.
CanonicalUnitEnablerQueryRecord	getCanonicalUnitEnablerQueryRecord(Type canonicalUnitEnablerRecordType) Gets the canonical unit enabler query record corresponding to the given CanonicalUnitEnabler record Type.
CatalogueQuery	getCatalogueQuery() Gets the query for a catalogue.
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.

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

matchRuledOfferingConstrainerId

void matchRuledOfferingConstrainerId(Id offeringConstrainerId,
                                   boolean match)

Matches enablers mapped to the offering constrainer.

Parameters:

offeringConstrainerId - the offering constrainer Id

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

Throws:

NullArgumentException - offeringConstrainerId is null

Compliance:

mandatory - This method must be implemented.

clearRuledOfferingConstrainerIdTerms

void clearRuledOfferingConstrainerIdTerms()

Clears the offering constrainer Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledOfferingConstrainerQuery

boolean supportsRuledOfferingConstrainerQuery()

Tests if an OfferingConstrainerQuery is available.

Returns:

true if an offering constrainer query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledOfferingConstrainerQuery

OfferingConstrainerQuery getRuledOfferingConstrainerQuery()

Gets the query for an offering constrainer. Multiple retrievals produce a nested OR term.

Returns:

the offering constrainer query

Throws:

UnimplementedException - supportsRuledOfferingConstrainerQuery() is false

Compliance:

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

matchAnyRuledOfferingConstrainer

void matchAnyRuledOfferingConstrainer(boolean match)

Matches enablers mapped to any offering constrainer.

Parameters:

match - true for enablers mapped to any offering constrainer, false to match enablers mapped to no offering constrainers

Compliance:

mandatory - This method must be implemented.

clearRuledOfferingConstrainerTerms

void clearRuledOfferingConstrainerTerms()

Clears the offering constrainer query terms.

Compliance:

mandatory - This method must be implemented.

matchCatalogueId

void matchCatalogueId(Id catalogueId,
                    boolean match)

Matches enablers mapped to the catalogue.

Parameters:

catalogueId - the catalogue Id

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

Throws:

NullArgumentException - catalogueId is null

Compliance:

mandatory - This method must be implemented.

clearCatalogueIdTerms

void clearCatalogueIdTerms()

Clears the catalogue Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsCatalogueQuery

boolean supportsCatalogueQuery()

Tests if a CatalogueQuery is available.

Returns:

true if a catalogue query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCatalogueQuery

CatalogueQuery getCatalogueQuery()

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

Returns:

the catalogue query

Throws:

UnimplementedException - supportsCatalogueQuery() is false

Compliance:

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

clearCatalogueTerms

void clearCatalogueTerms()

Clears the catalogue query terms.

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitEnablerQueryRecord

CanonicalUnitEnablerQueryRecord getCanonicalUnitEnablerQueryRecord(Type canonicalUnitEnablerRecordType)
                                                                   throws OperationFailedException

Gets the canonical unit enabler query record corresponding to the given CanonicalUnitEnabler record Type. Multiple record retrievals produce a nested OR term.

Parameters:

canonicalUnitEnablerRecordType - a canonical unit enabler record type

Returns:

the canonical unit enabler query record

Throws:

NullArgumentException - canonicalUnitEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.