public interface JobConstrainerQuery extends OsidConstrainerQuery
This is the query for searching job constrainers. 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 |
clearRuledJobIdTerms()
Clears the job
Id query terms. |
void |
clearRuledJobTerms()
Clears the job query terms.
|
FoundryQuery |
getFoundryQuery()
Gets the query for a foundry.
|
JobConstrainerQueryRecord |
getJobConstrainerQueryRecord(Type jobConstrainerRecordType)
Gets the job constrainer query record corresponding to the given
JobConstrainer record Type. |
JobQuery |
getRuledJobQuery()
Gets the query for a job.
|
void |
matchAnyRuledJob(boolean match)
Matches mapped to any job.
|
void |
matchFoundryId(Id foundryId,
boolean match)
Matches mapped to the foundry.
|
void |
matchRuledJobId(Id foundryId,
boolean match)
Matches mapped to a job.
|
boolean |
supportsFoundryQuery()
Tests if a
FoundryQuery is available. |
boolean |
supportsRuledJobQuery()
Tests if an
JobQuery 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 matchRuledJobId(Id foundryId, boolean match)
foundryId
- the job Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- foundryId
is
null
mandatory
- This method must be implemented. void clearRuledJobIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledJobQuery()
JobQuery
is available. true
if a job query is available, false
otherwisemandatory
- This method must be implemented. JobQuery getRuledJobQuery()
OR
term.UnimplementedException
- supportsRuledJobQuery()
is false
optional
- This method must be implemented if
supportsRuledJobQuery()
is true.
void matchAnyRuledJob(boolean match)
match
- true
for mapped to any job, false
to match mapped to no jobsmandatory
- This method must be implemented. void clearRuledJobTerms()
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. JobConstrainerQueryRecord getJobConstrainerQueryRecord(Type jobConstrainerRecordType) throws OperationFailedException
JobConstrainer
record Type.
Multiple
record retrievals produce a nested OR
term.jobConstrainerRecordType
- a job constrainer record typeNullArgumentException
- jobConstrainerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(jobConstrainerRecordType)
is
false
mandatory
- This method must be implemented.