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.
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. |
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
void matchRuledParameterId(Id parameterId, boolean match)
parameterId
- the parameter Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- parameterId
is
null
mandatory
- This method must be implemented. void clearRuledParameterIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledParameterQuery()
ParameterQuery
is available. true
if a parameter query is available,
false
otherwisemandatory
- This method must be implemented. ParameterQuery getRuledParameterQuery()
OR
term.UnimplementedException
-
supportsRuledParameterQuery()
is false
optional
- This method must be implemented if
supportsRuledParameterQuery()
is true.
void matchAnyRuledParameter(boolean match)
match
- true
for mapped to any parameter,
false
to match mapped to no parametersmandatory
- This method must be implemented. void clearRuledParameterTerms()
mandatory
- This method must be implemented. void matchConfigurationId(Id configurationId, boolean match)
configurationId
- the configuration Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- configurationId
is null
mandatory
- This method must be implemented. void clearConfigurationIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsConfigurationQuery()
ConfigurationQuery
is available. true
if a configuration query is available,
false
otherwisemandatory
- This method must be implemented. ConfigurationQuery getConfigurationQuery()
OR
term.UnimplementedException
-
supportsConfigurationQuery()
is false
optional
- This method must be implemented if
supportsConfigurationQuery()
is true.
void clearConfigurationTerms()
mandatory
- This method must be implemented. ParameterProcessorQueryRecord getParameterProcessorQueryRecord(Type parameterProcessorRecordType) throws OperationFailedException
ParameterProcessor
record Type.
Multiple
record retrievals produce a nested OR
term.parameterProcessorRecordType
- a parameter processor record typeNullArgumentException
-
parameterProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(parameterProcessorRecordType)
is
false
mandatory
- This method must be implemented.