org.osid.configuration.rules

Interface ParameterProcessorEnablerQuery

All Superinterfaces:

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

public interface ParameterProcessorEnablerQuery
extends OsidEnablerQuery

This is the query for searching parameter 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	clearConfigurationIdTerms() Clears the configuration Id query terms.
void	clearConfigurationTerms() Clears the configuration query terms.
void	clearRuledParameterProcessorIdTerms() Clears the parameter processor Id query terms.
void	clearRuledParameterProcessorTerms() Clears the parameter processor query terms.
ConfigurationQuery	getConfigurationQuery() Gets the query for a configuration.
ParameterProcessorEnablerQueryRecord	getParameterProcessorEnablerQueryRecord(Type parameterProcessorEnablerRecordType) Gets the parameter processor enabler query record corresponding to the given ParameterProcessorEnabler record Type.
ParameterProcessorQuery	getRuledParameterProcessorQuery() Gets the query for a parameter processor.
void	matchAnyRuledParameterProcessor(boolean match) Matches enablers mapped to any parameter processor.
void	matchConfigurationId(Id configurationId, boolean match) Matches enablers mapped to the configuration.
void	matchRuledParameterProcessorId(Id parameterProcessorId, boolean match) Matches enablers mapped to the parameter processor.
boolean	supportsConfigurationQuery() Tests if a ConfigurationQuery is available.
boolean	supportsRuledParameterProcessorQuery() Tests if a ParameterProcessorQuery 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

matchRuledParameterProcessorId

void matchRuledParameterProcessorId(Id parameterProcessorId,
                                  boolean match)

Matches enablers mapped to the parameter processor.

Parameters:

parameterProcessorId - the parameter processor Id

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

Throws:

NullArgumentException - parameterProcessorId is null

Compliance:

mandatory - This method must be implemented.

clearRuledParameterProcessorIdTerms

void clearRuledParameterProcessorIdTerms()

Clears the parameter processor Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledParameterProcessorQuery

boolean supportsRuledParameterProcessorQuery()

Tests if a ParameterProcessorQuery is available.

Returns:

true if a parameter processor query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledParameterProcessorQuery

ParameterProcessorQuery getRuledParameterProcessorQuery()

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

Returns:

the parameter processor query

Throws:

UnimplementedException - supportsRuledParameterProcessorQuery() is false

Compliance:

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

matchAnyRuledParameterProcessor

void matchAnyRuledParameterProcessor(boolean match)

Matches enablers mapped to any parameter processor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRuledParameterProcessorTerms

void clearRuledParameterProcessorTerms()

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

getParameterProcessorEnablerQueryRecord

ParameterProcessorEnablerQueryRecord getParameterProcessorEnablerQueryRecord(Type parameterProcessorEnablerRecordType)
                                                                             throws OperationFailedException

Gets the parameter processor enabler query record corresponding to the given ParameterProcessorEnabler record Type. Multiple record retrievals produce a nested OR term.

Parameters:

parameterProcessorEnablerRecordType - a parameter processor enabler record type

Returns:

the parameter processor enabler query record

Throws:

NullArgumentException - parameterProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(parameterProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.