org.osid.configuration.rules

Interface ValueEnablerQuery

All Superinterfaces:

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

public interface ValueEnablerQuery
extends OsidEnablerQuery

This is the query for searching value 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	clearConfigurationIdTerms() Clears the configuration Id query terms.
void	clearConfigurationTerms() Clears the configuration query terms.
void	clearRuledValueIdTerms() Clears the value Id query terms.
void	clearRuledValueTerms() Clears the value query terms.
ConfigurationQuery	getConfigurationQuery() Gets the query for a configuration.
ValueQuery	getRuledValueQuery() Gets the query for a value.
ValueEnablerQueryRecord	getValueEnablerQueryRecord(Type valueEnablerRecordType) Gets the value enabler query record corresponding to the given ValueEnabler record Type.
void	matchAnyRuledValue(boolean match) Matches enablers mapped to any value.
void	matchConfigurationId(Id configurationId, boolean match) Matches enablers mapped to the configuration.
void	matchRuledValueId(Id valueId, boolean match) Matches enablers mapped to the value.
boolean	supportsConfigurationQuery() Tests if a ConfigurationQuery is available.
boolean	supportsRuledValueQuery() Tests if a ValueQuery 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

matchRuledValueId

void matchRuledValueId(Id valueId,
                     boolean match)

Matches enablers mapped to the value.

Parameters:

valueId - the value Id

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

Throws:

NullArgumentException - valueId is null

Compliance:

mandatory - This method must be implemented.

clearRuledValueIdTerms

void clearRuledValueIdTerms()

Clears the value Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledValueQuery

boolean supportsRuledValueQuery()

Tests if a ValueQuery is available.

Returns:

true if a value query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledValueQuery

ValueQuery getRuledValueQuery()

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

Returns:

the value query

Throws:

UnimplementedException - supportsRuleValueQuery() is false

Compliance:

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

matchAnyRuledValue

void matchAnyRuledValue(boolean match)

Matches enablers mapped to any value.

Parameters:

match - true for enablers mapped to any value, false to match enablers mapped to no value

Compliance:

mandatory - This method must be implemented.

clearRuledValueTerms

void clearRuledValueTerms()

Clears the value query terms.

Compliance:

mandatory - This method must be implemented.

matchConfigurationId

void matchConfigurationId(Id configurationId,
                        boolean match)

Matches enablers mapped to the configuration.

Parameters:

configurationId - the configuration Id

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

Throws:

NullArgumentException - configurationId is null

Compliance:

mandatory - This method must be implemented.

clearConfigurationIdTerms

void clearConfigurationIdTerms()

Clears the configuration Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsConfigurationQuery

boolean supportsConfigurationQuery()

Tests if a ConfigurationQuery is available.

Returns:

true if a configuration query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getConfigurationQuery

ConfigurationQuery getConfigurationQuery()

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

Returns:

the configuration query

Throws:

UnimplementedException - supportsConfigurationQuery() is false

Compliance:

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

clearConfigurationTerms

void clearConfigurationTerms()

Clears the configuration query terms.

Compliance:

mandatory - This method must be implemented.

getValueEnablerQueryRecord

ValueEnablerQueryRecord getValueEnablerQueryRecord(Type valueEnablerRecordType)
                                                   throws OperationFailedException

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

Parameters:

valueEnablerRecordType - a value enabler record type

Returns:

the value enabler query record

Throws:

NullArgumentException - valueEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(valueEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.