public interface SupersedingEventEnablerQuery extends OsidEnablerQuery
This is the query for searching superseding event 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 |
clearRuledSupersedingEventIdTerms()
Clears the superseding event
Id query terms. |
void |
clearRuledSupersedingEventTerms()
Clears the calendar query terms.
|
CalendarQuery |
getCalendarQuery()
Gets the query for a calendar.
|
SupersedingEventQuery |
getRuledSupersedingEventQuery()
Gets the query for a supsreding event.
|
SupersedingEventEnablerQueryRecord |
getSupersedingEventEnablerQueryRecord(Type supersedingEventEnablerRecordType)
Gets the superseding event enabler query record corresponding to the
given
SupersedingEventEnabler record Type. |
void |
matchAnyRuledSupersedingEvent(boolean match)
Matches enablers mapped to any supsreding event.
|
void |
matchCalendarId(Id calendarId,
boolean match)
Matches enablers mapped to the calendar.
|
void |
matchRuledSupersedingEventId(Id supersedingEventId,
boolean match)
Matches enablers mapped to the superseding event.
|
boolean |
supportsCalendarQuery()
Tests if a
CalendarQuery is available. |
boolean |
supportsRuledSupersedingEventQuery()
Tests if an
SupersedingEventQuery 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 matchRuledSupersedingEventId(Id supersedingEventId, boolean match)
supersedingEventId
- the superseding event Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- supersedingEventId
is null
mandatory
- This method must be implemented. void clearRuledSupersedingEventIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledSupersedingEventQuery()
SupersedingEventQuery
is available. true
if a superseding event query is available,
false
otherwisemandatory
- This method must be implemented. SupersedingEventQuery getRuledSupersedingEventQuery()
OR
term.UnimplementedException
-
supportsRuledSupersedingEventQuery()
is false
optional
- This method must be implemented if
supportsRuledSupersedingEventQuery()
is
true.
void matchAnyRuledSupersedingEvent(boolean match)
match
- true
for enablers mapped to any
supsreding event, false
to match enablers
mapped to no supsreding eventsmandatory
- This method must be implemented. void clearRuledSupersedingEventTerms()
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 a 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. SupersedingEventEnablerQueryRecord getSupersedingEventEnablerQueryRecord(Type supersedingEventEnablerRecordType) throws OperationFailedException
SupersedingEventEnabler
record Type.
Multiple record retrievals produce a nested OR
term.supersedingEventEnablerRecordType
- a superseding event enabler
record typeNullArgumentException
-
supersedingEventEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(supersedingEventEnablerRecordType)
is
false
mandatory
- This method must be implemented.