public interface StepProcessorEnablerQuery extends OsidEnablerQuery
This is the query for searching step processor enablers. Each method
match specifies a AND
term while multiple invocations of
the same method produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearOfficeIdTerms()
Clears the office
Id query terms. |
void |
clearOfficeTerms()
Clears the office query terms.
|
void |
clearRuledStepProcessorIdTerms()
Clears the step processor
Id query terms. |
void |
clearRuledStepProcessorTerms()
Clears the step processor query terms.
|
OfficeQuery |
getOfficeQuery()
Gets the query for an office.
|
StepProcessorQuery |
getRuledStepProcessorQuery()
Gets the query for a step processor.
|
StepProcessorEnablerQueryRecord |
getStepProcessorEnablerQueryRecord(Type stepProcessorEnablerRecordType)
Gets the step processor enabler query record corresponding to the
given
StepProcessorEnabler record Type. |
void |
matchAnyRuledStepProcessor(boolean match)
Matches enablers mapped to any step processor.
|
void |
matchOfficeId(Id officeId,
boolean match)
Matches enablers mapped to the office.
|
void |
matchRuledStepProcessorId(Id stepProcessorId,
boolean match)
Matches enablers mapped to the step processor.
|
boolean |
supportsOfficeQuery()
Tests if an
OfficeQuery is available. |
boolean |
supportsRuledStepProcessorQuery()
Tests if a
StepProcessorQuery 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 matchRuledStepProcessorId(Id stepProcessorId, boolean match)
stepProcessorId
- the step processor Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- stepProcessorId
is null
mandatory
- This method must be implemented. void clearRuledStepProcessorIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledStepProcessorQuery()
StepProcessorQuery
is available. true
if a step processor query is available,
false
otherwisemandatory
- This method must be implemented. StepProcessorQuery getRuledStepProcessorQuery()
OR
term.UnimplementedException
-
supportsRuledStepProcessorQuery()
is false
optional
- This method must be implemented if
supportsRuledStepProcessorQuery()
is true.
void matchAnyRuledStepProcessor(boolean match)
match
- true
for enablers mapped to any step
processor, false
to match enablers mapped to no
step processorsmandatory
- This method must be implemented. void clearRuledStepProcessorTerms()
mandatory
- This method must be implemented. void matchOfficeId(Id officeId, boolean match)
officeId
- the office Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- officeId
is
null
mandatory
- This method must be implemented. void clearOfficeIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsOfficeQuery()
OfficeQuery
is available. true
if an office query is available,
false
otherwisemandatory
- This method must be implemented. OfficeQuery getOfficeQuery()
OR
term.UnimplementedException
- supportsOfficeQuery()
is false
optional
- This method must be implemented if
supportsOfficeQuery()
is true.
void clearOfficeTerms()
mandatory
- This method must be implemented. StepProcessorEnablerQueryRecord getStepProcessorEnablerQueryRecord(Type stepProcessorEnablerRecordType) throws OperationFailedException
StepProcessorEnabler
record Type.
Multiple record retrievals produce a nested OR
term.stepProcessorEnablerRecordType
- a step processor enabler record
typeNullArgumentException
-
stepProcessorEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(stepProcessorEnablerRecordType)
is
false
mandatory
- This method must be implemented.