org.osid.offering.rules

Interface CanonicalUnitProcessorEnablerQuery

All Superinterfaces:

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

public interface CanonicalUnitProcessorEnablerQuery
extends OsidEnablerQuery

This is the query for searching canonical unit processor 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	clearRuledCanonicalUnitProcessorIdTerms() Clears the canonical unit processor Id query terms.
void	clearRuledCanonicalUnitProcessorTerms() Clears the canonical unit processor query terms.
CanonicalUnitProcessorEnablerQueryRecord	getCanonicalUnitProcessorEnablerQueryRecord(Type canonicalUnitProcessorEnablerRecordType) Gets the canonical unit processor enabler query record corresponding to the given CanonicalUnitProcessorEnabler record Type.
CatalogueQuery	getCatalogueQuery() Gets the query for a catalogue.
CanonicalUnitProcessorQuery	getRuledCanonicalUnitProcessorQuery() Gets the query for a canonical unit processor.
void	matchAnyRuledCanonicalUnitProcessor(boolean match) Matches enablers mapped to any canonical unit processor.
void	matchCatalogueId(Id catalogueId, boolean match) Matches enablers mapped to the catalogue.
void	matchRuledCanonicalUnitProcessorId(Id canonicalUnitProcessorId, boolean match) Matches enablers mapped to the canonical unit processor.
boolean	supportsCatalogueQuery() Tests if a CatalogueQuery is available.
boolean	supportsRuledCanonicalUnitProcessorQuery() Tests if a CanonicalUnitProcessorQuery 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

matchRuledCanonicalUnitProcessorId

void matchRuledCanonicalUnitProcessorId(Id canonicalUnitProcessorId,
                                      boolean match)

Matches enablers mapped to the canonical unit processor.

Parameters:

canonicalUnitProcessorId - the canonical unit Id

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

Throws:

NullArgumentException - canonicalUnitProcessorId is null

Compliance:

mandatory - This method must be implemented.

clearRuledCanonicalUnitProcessorIdTerms

void clearRuledCanonicalUnitProcessorIdTerms()

Clears the canonical unit processor Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledCanonicalUnitProcessorQuery

boolean supportsRuledCanonicalUnitProcessorQuery()

Tests if a CanonicalUnitProcessorQuery is available.

Returns:

true if a canonical unit processor query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledCanonicalUnitProcessorQuery

CanonicalUnitProcessorQuery getRuledCanonicalUnitProcessorQuery()

Gets the query for a canonical unit processor. Multiple retrievals produce a nested OR term.

Returns:

the canonical unit processor query

Throws:

UnimplementedException - supportsRuledCanonicalUnitProcessorQuery() is false

Compliance:

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

matchAnyRuledCanonicalUnitProcessor

void matchAnyRuledCanonicalUnitProcessor(boolean match)

Matches enablers mapped to any canonical unit processor.

Parameters:

match - true for enablers mapped to any canonical unit processor, false to match enablers mapped to no canonical unit processors

Compliance:

mandatory - This method must be implemented.

clearRuledCanonicalUnitProcessorTerms

void clearRuledCanonicalUnitProcessorTerms()

Clears the canonical unit processor 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.

getCanonicalUnitProcessorEnablerQueryRecord

CanonicalUnitProcessorEnablerQueryRecord getCanonicalUnitProcessorEnablerQueryRecord(Type canonicalUnitProcessorEnablerRecordType)
                                                                                     throws OperationFailedException

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

Parameters:

canonicalUnitProcessorEnablerRecordType - a canonical unit processor enabler record type

Returns:

the canonical unit processor enabler query record

Throws:

NullArgumentException - canonicalUnitProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.