org.osid.resource.demographic

Interface DemographicEnablerQuery

All Superinterfaces:

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

public interface DemographicEnablerQuery
extends OsidEnablerQuery

This is the query for searching demographic 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	clearBinIdTerms() Clears the bin Id query terms.
void	clearBinTerms() Clears the bin query terms.
void	clearRuledDemographicIdTerms() Clears the demographic Id query terms.
void	clearRuledDemographicTerms() Clears the demographic query terms.
BinQuery	getBinQuery() Gets the query for a bin.
DemographicEnablerQueryRecord	getDemographicEnablerQueryRecord(Type demographicEnablerRecordType) Gets the demographic enabler query record corresponding to the given DemographicEnabler record Type.
DemographicQuery	getRuledDemographicQuery() Gets the query for a demographic.
void	matchAnyRuledDemographic(boolean match) Matches enablers mapped to any demographic.
void	matchBinId(Id binId, boolean match) Matches enablers mapped to the bin.
void	matchRuledDemographicId(Id demographicId, boolean match) Matches enablers mapped to the demographic.
boolean	supportsBinQuery() Tests if a BinQuery is available.
boolean	supportsRuledDemographicQuery() Tests if a DemographicQuery 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

matchRuledDemographicId

void matchRuledDemographicId(Id demographicId,
                           boolean match)

Matches enablers mapped to the demographic.

Parameters:

demographicId - the demographic Id

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

Throws:

NullArgumentException - demographicId is null

Compliance:

mandatory - This method must be implemented.

clearRuledDemographicIdTerms

void clearRuledDemographicIdTerms()

Clears the demographic Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledDemographicQuery

boolean supportsRuledDemographicQuery()

Tests if a DemographicQuery is available.

Returns:

true if a demographic query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledDemographicQuery

DemographicQuery getRuledDemographicQuery()

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

Returns:

the demographic query

Throws:

UnimplementedException - supportsRuledDemographicQuery() is false

Compliance:

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

matchAnyRuledDemographic

void matchAnyRuledDemographic(boolean match)

Matches enablers mapped to any demographic.

Parameters:

match - true for enablers mapped to any demographic, false to match enablers mapped to no demographics

Compliance:

mandatory - This method must be implemented.

clearRuledDemographicTerms

void clearRuledDemographicTerms()

Clears the demographic query terms.

Compliance:

mandatory - This method must be implemented.

matchBinId

void matchBinId(Id binId,
              boolean match)

Matches enablers mapped to the bin.

Parameters:

binId - the bin Id

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

Throws:

NullArgumentException - binId is null

Compliance:

mandatory - This method must be implemented.

clearBinIdTerms

void clearBinIdTerms()

Clears the bin Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsBinQuery

boolean supportsBinQuery()

Tests if a BinQuery is available.

Returns:

true if a bin query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBinQuery

BinQuery getBinQuery()

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

Returns:

the bin query

Throws:

UnimplementedException - supportsBinQuery() is false

Compliance:

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

clearBinTerms

void clearBinTerms()

Clears the bin query terms.

Compliance:

mandatory - This method must be implemented.

getDemographicEnablerQueryRecord

DemographicEnablerQueryRecord getDemographicEnablerQueryRecord(Type demographicEnablerRecordType)
                                                               throws OperationFailedException

Gets the demographic enabler query record corresponding to the given DemographicEnabler record Type. Multiple record retrievals produce a nested OR term.

Parameters:

demographicEnablerRecordType - a demographic enabler record type

Returns:

the demographic enabler query record

Throws:

NullArgumentException - demographicEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(demographicEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.