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.
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. |
clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchRuledParameterProcessorId(Id parameterProcessorId, boolean match)
parameterProcessorId
- the parameter processor Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- parameterProcessorId
is null
mandatory
- This method must be implemented. void clearRuledParameterProcessorIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledParameterProcessorQuery()
ParameterProcessorQuery
is available. true
if a parameter processor query is
available, false
otherwisemandatory
- This method must be implemented. ParameterProcessorQuery getRuledParameterProcessorQuery()
OR
term.UnimplementedException
-
supportsRuledParameterProcessorQuery()
is false
optional
- This method must be implemented if
supportsRuledParameterProcessorQuery()
is
true.
void matchAnyRuledParameterProcessor(boolean match)
match
- true
for enablers mapped to any parameter
processor, false
to match enablers mapped to no
parameter processorsmandatory
- This method must be implemented. void clearRuledParameterProcessorTerms()
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. ParameterProcessorEnablerQueryRecord getParameterProcessorEnablerQueryRecord(Type parameterProcessorEnablerRecordType) throws OperationFailedException
ParameterProcessorEnabler
record Type.
Multiple record retrievals produce a nested OR
term.parameterProcessorEnablerRecordType
- a parameter processor
enabler record typeNullArgumentException
-
parameterProcessorEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(parameterProcessorEnablerRecordType)
is
false
mandatory
- This method must be implemented.