public interface StepProcessorQuery extends OsidProcessorQuery
This is the query for searching step processors. 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 |
clearRuledStepIdTerms()
Clears the step
Id query terms. |
void |
clearRuledStepTerms()
Clears the step query terms.
|
OfficeQuery |
getOfficeQuery()
Gets the query for an office.
|
StepQuery |
getRuledStepQuery()
Gets the query for a step.
|
StepProcessorQueryRecord |
getStepProcessorQueryRecord(Type stepProcessorRecordType)
Gets the step processor query record corresponding to the given
StepProcessor record Type. |
void |
matchAnyRuledStep(boolean match)
Matches any rule mapped to any step.
|
void |
matchOfficeId(Id officeId,
boolean match)
Matches rules mapped to the office.
|
void |
matchRuledStepId(Id stepId,
boolean match)
Matches rules mapped to the step.
|
boolean |
supportsOfficeQuery()
Tests if an
OfficeQuery is available. |
boolean |
supportsRuledStepQuery()
Tests if a
StepQuery 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 matchRuledStepId(Id stepId, boolean match)
stepId
- the step Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- stepId
is
null
mandatory
- This method must be implemented. void clearRuledStepIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledStepQuery()
StepQuery
is available. true
if a step query is available, false
otherwisemandatory
- This method must be implemented. StepQuery getRuledStepQuery()
OR
term.UnimplementedException
-
supportsRuledStepQuery()
is false
optional
- This method must be implemented if
supportsRuledStepQuery()
is true.
void matchAnyRuledStep(boolean match)
match
- true
for rules mapped to any step,
false
to match rules mapped to no stepmandatory
- This method must be implemented. void clearRuledStepTerms()
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. StepProcessorQueryRecord getStepProcessorQueryRecord(Type stepProcessorRecordType) throws OperationFailedException
StepProcessor
record Type.
Multiple record
retrievals produce a nested OR
term.stepProcessorRecordType
- a step processor record typeNullArgumentException
- stepProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(stepProcessorRecordType)
is false
mandatory
- This method must be implemented.