public interface CommitmentEnablerQuery extends OsidEnablerQuery
This is the query for searching commitment 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 |
clearCalendarIdTerms()
Clears the calendar
Id query terms. |
void |
clearCalendarTerms()
Clears the calendar query terms.
|
void |
clearRuledCommitmentIdTerms()
Clears the commitment
Id query terms. |
void |
clearRuledCommitmentTerms()
Clears the commitment query terms.
|
CalendarQuery |
getCalendarQuery()
Gets the query for an calendar.
|
CommitmentEnablerQueryRecord |
getCommitmentEnablerQueryRecord(Type commitmentEnablerRecordType)
Gets the commitment enabler query record corresponding to the given
CommitmentEnabler record Type. |
CommitmentQuery |
getRuledCommitmentQuery()
Gets the query for a commitment.
|
void |
matchAnyRuledCommitment(boolean match)
Matches enablers mapped to any commitment.
|
void |
matchCalendarId(Id calendarId,
boolean match)
Matches enablers mapped to the calendar.
|
void |
matchRuledCommitmentId(Id commitmentId,
boolean match)
Matches enablers mapped to the commitment.
|
boolean |
supportsCalendarQuery()
Tests if an
CalendarQuery is available. |
boolean |
supportsRuledCommitmentQuery()
Tests if a
CommitmentBookQuery 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 matchRuledCommitmentId(Id commitmentId, boolean match)
commitmentId
- the commitment book Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- commitmentBookId
is null
mandatory
- This method must be implemented. void clearRuledCommitmentIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledCommitmentQuery()
CommitmentBookQuery
is available. true
if a commitment query is available,
false
otherwisemandatory
- This method must be implemented. CommitmentQuery getRuledCommitmentQuery()
OR
term.UnimplementedException
-
supportsCommitmentQuery()
is false
optional
- This method must be implemented if
supportsCommitmentQuery()
is true.
void matchAnyRuledCommitment(boolean match)
match
- true
for enablers mapped to any
commitment, false
to match enablers mapped to
no commitmentmandatory
- This method must be implemented. void clearRuledCommitmentTerms()
mandatory
- This method must be implemented. void matchCalendarId(Id calendarId, boolean match)
calendarId
- the calendar Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- calendarId
is
null
mandatory
- This method must be implemented. void clearCalendarIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsCalendarQuery()
CalendarQuery
is available. true
if an calendar query is available,
false
otherwisemandatory
- This method must be implemented. CalendarQuery getCalendarQuery()
OR
term.UnimplementedException
- supportsCalendarQuery()
is false
optional
- This method must be implemented if
supportsCalendarQuery()
is true.
void clearCalendarTerms()
mandatory
- This method must be implemented. CommitmentEnablerQueryRecord getCommitmentEnablerQueryRecord(Type commitmentEnablerRecordType) throws OperationFailedException
CommitmentEnabler
record Type.
Multiple
record retrievals produce a nested OR
term.commitmentEnablerRecordType
- a commitment enabler record typeNullArgumentException
-
commitmentEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(commitmentEnablerRecordType)
is
false
mandatory
- This method must be implemented.