public interface CommissionEnablerQuery extends OsidEnablerQuery
This is the query for searching commission 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 |
clearRuledCommissionIdTerms()
Clears the commission
Id query terms. |
void |
clearRuledCommissionTerms()
Clears the commission query terms.
|
CommissionEnablerQueryRecord |
getCommissionEnablerQueryRecord(Type commissionEnablerRecordType)
Gets the commission enabler query record corresponding to the given
CommissionEnabler record Type. |
FoundryQuery |
getFoundryQuery()
Gets the query for a foundry.
|
CommissionQuery |
getRuledCommissionQuery()
Gets the query for a commission.
|
void |
matchAnyRuledCommission(boolean match)
Matches mapped to any commission.
|
void |
matchFoundryId(Id foundryId,
boolean match)
Matches mapped to the foundry.
|
void |
matchRuledCommissionId(Id foundryId,
boolean match)
Matches mapped to a commission.
|
boolean |
supportsFoundryQuery()
Tests if a
FoundryQuery is available. |
boolean |
supportsRuledCommissionQuery()
Tests if an
CommissionQuery 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 matchRuledCommissionId(Id foundryId, boolean match)
foundryId
- the commission Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- foundryId
is
null
mandatory
- This method must be implemented. void clearRuledCommissionIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledCommissionQuery()
CommissionQuery
is available. true
if a commission query is available,
false
otherwisemandatory
- This method must be implemented. CommissionQuery getRuledCommissionQuery()
OR
term.UnimplementedException
-
supportsRuledCommissionQuery()
is false
optional
- This method must be implemented if
supportsRuledCommissionQuery()
is true.
void matchAnyRuledCommission(boolean match)
match
- true
for mapped to any commission,
false
to match mapped to no commissionsmandatory
- This method must be implemented. void clearRuledCommissionTerms()
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. CommissionEnablerQueryRecord getCommissionEnablerQueryRecord(Type commissionEnablerRecordType) throws OperationFailedException
CommissionEnabler
record Type.
Multiple
record retrievals produce a nested OR
term.commissionEnablerRecordType
- an commission enabler record typeNullArgumentException
-
commissionEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(commissionEnablerRecordType)
is
false
mandatory
- This method must be implemented.