org.osid.configuration.rules

Interface ParameterProcessorQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidProcessorQuery, OsidQuery, OsidRuleQuery, Suppliable

public interface ParameterProcessorQuery
extends OsidProcessorQuery

This is the query for searching parameter processors. 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	clearRuledParameterIdTerms() Clears the parameter Id query terms.
void	clearRuledParameterTerms() Clears the parameter query terms.
ConfigurationQuery	getConfigurationQuery() Gets the query for a configuration.
ParameterProcessorQueryRecord	getParameterProcessorQueryRecord(Type parameterProcessorRecordType) Gets the parameter processor query record corresponding to the given ParameterProcessor record Type.
ParameterQuery	getRuledParameterQuery() Gets the query for a parameter.
void	matchAnyRuledParameter(boolean match) Matches mapped to any parameter.
void	matchConfigurationId(Id configurationId, boolean match) Matches mapped to the configuration.
void	matchRuledParameterId(Id parameterId, boolean match) Matches mapped to the parameter.
boolean	supportsConfigurationQuery() Tests if a ConfigurationQuery is available.
boolean	supportsRuledParameterQuery() Tests if a ParameterQuery is available.

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

Method Detail

matchRuledParameterId

void matchRuledParameterId(Id parameterId,
                         boolean match)

Matches mapped to the parameter.

Parameters:

parameterId - the parameter Id

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

Throws:

NullArgumentException - parameterId is null

Compliance:

mandatory - This method must be implemented.

clearRuledParameterIdTerms

void clearRuledParameterIdTerms()

Clears the parameter Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledParameterQuery

boolean supportsRuledParameterQuery()

Tests if a ParameterQuery is available.

Returns:

true if a parameter query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledParameterQuery

ParameterQuery getRuledParameterQuery()

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

Returns:

the parameter query

Throws:

UnimplementedException - supportsRuledParameterQuery() is false

Compliance:

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

matchAnyRuledParameter

void matchAnyRuledParameter(boolean match)

Matches mapped to any parameter.

Parameters:

match - true for mapped to any parameter, false to match mapped to no parameters

Compliance:

mandatory - This method must be implemented.

clearRuledParameterTerms

void clearRuledParameterTerms()

Clears the parameter query terms.

Compliance:

mandatory - This method must be implemented.

matchConfigurationId

void matchConfigurationId(Id configurationId,
                        boolean match)

Matches 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.

getParameterProcessorQueryRecord

ParameterProcessorQueryRecord getParameterProcessorQueryRecord(Type parameterProcessorRecordType)
                                                               throws OperationFailedException

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

Parameters:

parameterProcessorRecordType - a parameter processor record type

Returns:

the parameter processor query record

Throws:

NullArgumentException - parameterProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(parameterProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.