public interface RecurringEventEnablerQuery extends OsidEnablerQuery
This is the query for searching recurring 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 |
clearRuledRecurringEventIdTerms()
Clears the recurring event
Id query terms. |
void |
clearRuledRecurringEventTerms()
Clears the recurring event query terms.
|
CalendarQuery |
getCalendarQuery()
Gets the query for a calendar.
|
RecurringEventEnablerQueryRecord |
getRecurringEventEnablerQueryRecord(Type recurringEventEnablerRecordType)
Gets the recurring event enabler query record corresponding to the
given
RecurringEventEnabler record Type. |
RecurringEventQuery |
getRuledRecurringEventQuery()
Gets the query for a recurring event.
|
void |
matchAnyRuledRecurringEvent(boolean match)
Matches enablers mapped to any recurring event.
|
void |
matchCalendarId(Id calendarId,
boolean match)
Matches enablers mapped to the calendar.
|
void |
matchRuledRecurringEventId(Id recurringEventId,
boolean match)
Matches enablers mapped to the recurring event.
|
boolean |
supportsCalendarQuery()
Tests if a
CalendarQuery is available. |
boolean |
supportsRuledRecurringEventQuery()
Tests if a
RecurringEventQuery 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 matchRuledRecurringEventId(Id recurringEventId, boolean match)
recurringEventId
- the recurring event Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- recurringEventId
is null
mandatory
- This method must be implemented. void clearRuledRecurringEventIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledRecurringEventQuery()
RecurringEventQuery
is available. true
if a recurring event query is available,
false
otherwisemandatory
- This method must be implemented. RecurringEventQuery getRuledRecurringEventQuery()
OR
term.UnimplementedException
-
supportsRuledRecurringEventQuery()
is false
optional
- This method must be implemented if
supportsRuledRecurringEventQuery()
is true.
void matchAnyRuledRecurringEvent(boolean match)
match
- true
for enablers mapped to any recurring
event, false
to match enablers mapped to no
recurring eventsmandatory
- This method must be implemented. void clearRuledRecurringEventTerms()
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. RecurringEventEnablerQueryRecord getRecurringEventEnablerQueryRecord(Type recurringEventEnablerRecordType) throws OperationFailedException
RecurringEventEnabler
record Type.
Multiple record retrievals produce a nested OR
term.recurringEventEnablerRecordType
- a recurring event enabler
record typeNullArgumentException
-
recurringEventEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(recurringEventEnablerRecordType)
is
false
mandatory
- This method must be implemented.