public interface JobConstrainerEnablerQuery extends OsidEnablerQuery
This is the query for searching job constrainer 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 |
clearFoundryIdTerms()
Clears the foundry
Id query terms. |
void |
clearFoundryTerms()
Clears the foundry query terms.
|
void |
clearRuledJobConstrainerIdTerms()
Clears the job constrainer
Id query terms. |
void |
clearRuledJobConstrainerTerms()
Clears the job constrainer query terms.
|
FoundryQuery |
getFoundryQuery()
Gets the query for a foundry.
|
JobConstrainerEnablerQueryRecord |
getJobConstrainerEnablerQueryRecord(Type jobConstrainerEnablerRecordType)
Gets the job constrainer enabler query record corresponding to the
given
JobConstrainerEnabler record Type. |
JobConstrainerQuery |
getRuledJobConstrainerQuery()
Gets the query for a job constrainer.
|
void |
matchAnyRuledJobConstrainer(boolean match)
Matches enablers mapped to any job constrainer.
|
void |
matchFoundryId(Id foundryId,
boolean match)
Matches enablers mapped to the foundry.
|
void |
matchRuledJobConstrainerId(Id jobConstrainerId,
boolean match)
Matches enablers mapped to the job constrainer.
|
boolean |
supportsFoundryQuery()
Tests if a
FoundryQuery is available. |
boolean |
supportsRuledJobConstrainerQuery()
Tests if an
JobConstrainerQuery 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 matchRuledJobConstrainerId(Id jobConstrainerId, boolean match)
jobConstrainerId
- the job constrainer Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- jobConstrainerId
is null
mandatory
- This method must be implemented. void clearRuledJobConstrainerIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledJobConstrainerQuery()
JobConstrainerQuery
is available. true
if a job constrainer query is available,
false
otherwisemandatory
- This method must be implemented. JobConstrainerQuery getRuledJobConstrainerQuery()
OR
term.UnimplementedException
-
supportsRuledJobConstrainerQuery()
is false
optional
- This method must be implemented if
supportsRuledJobConstrainerQuery()
is true.
void matchAnyRuledJobConstrainer(boolean match)
match
- true
for enablers mapped to any job
constrainer, false
to match enablers mapped to
no job constrainersmandatory
- This method must be implemented. void clearRuledJobConstrainerTerms()
mandatory
- This method must be implemented. void matchFoundryId(Id foundryId, boolean match)
foundryId
- the foundry Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- foundryId
is
null
mandatory
- This method must be implemented. void clearFoundryIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsFoundryQuery()
FoundryQuery
is available. true
if a foundry query is available,
false
otherwisemandatory
- This method must be implemented. FoundryQuery getFoundryQuery()
OR
term.UnimplementedException
- supportsFoundryQuery()
is false
optional
- This method must be implemented if
supportsFoundryQuery()
is true.
void clearFoundryTerms()
mandatory
- This method must be implemented. JobConstrainerEnablerQueryRecord getJobConstrainerEnablerQueryRecord(Type jobConstrainerEnablerRecordType) throws OperationFailedException
JobConstrainerEnabler
record Type.
Multiple record retrievals produce a nested OR
term.jobConstrainerEnablerRecordType
- a job constrainer enabler
record typeNullArgumentException
-
jobConstrainerEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(jobConstrainerEnablerRecordType)
is
false
mandatory
- This method must be implemented.