public interface RecurringEventQuery extends OsidRuleQuery, OsidContainableQuery
This is the query for searching recurring events. Each method match
request produces an AND
term while multiple invocations of
a method produces a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearBlackoutInclusiveTerms()
Clears the blackout terms.
|
void |
clearBlackoutTerms()
Clears the blackout terms.
|
void |
clearCalendarIdTerms()
Clears the calendar
Id terms. |
void |
clearCalendarTerms()
Clears the calendar terms.
|
void |
clearEventIdTerms()
Clears the event
Id terms. |
void |
clearEventTerms()
Clears the event terms.
|
void |
clearScheduleIdTerms()
Clears the schedule
Id terms. |
void |
clearScheduleTerms()
Clears the schedule terms.
|
void |
clearSpecificMeetingTimeTerms()
Clears the blackout terms.
|
void |
clearSponsorIdTerms()
Clears the sponsor
Id terms. |
void |
clearSponsorTerms()
Clears the sponsor terms.
|
void |
clearSupersedingEventIdTerms()
Clears the superseding event
Id terms. |
void |
clearSupersedingEventTerms()
Clears the superseding event terms.
|
CalendarQuery |
getCalendarQuery()
Gets the query for a calendar.
|
EventQuery |
getEventQuery()
Gets the query for an event.
|
RecurringEventQueryRecord |
getRecurringEventQueryRecord(Type recurringEventRecordType)
Gets the recurring event query recod corresponding to the given
RecurringEvent record Type. |
ScheduleQuery |
getScheduleQuery()
Gets the query for a schedule.
|
ResourceQuery |
getSponsorQuery()
Gets the query for a sponsor.
|
SupersedingEventQuery |
getSupersedingEventQuery()
Gets the query for a superseding event.
|
void |
matchAnyBlackout(boolean match)
Matches a recurring event that has any blackout assigned.
|
void |
matchAnyEvent(boolean match)
Matches a recurring event that has any composed event assigned.
|
void |
matchAnySchedule(boolean match)
Matches a recurring event that has any schedule assigned.
|
void |
matchAnySpecificMeetingTime(boolean match)
Matches a recurring event that has any specific date assigned.
|
void |
matchAnySupersedingEvent(boolean match)
Matches a recurring event that has any superseding event assigned.
|
void |
matchBlackout(DateTime datetime,
boolean match)
Matches a blackout that contains the given date time.
|
void |
matchBlackoutInclusive(DateTime start,
DateTime end,
boolean match)
Matches recurring events with blackouts between the given range
inclusive.
|
void |
matchCalendarId(Id calendarId,
boolean match)
Sets the calendar
Id for this query. |
void |
matchEventId(Id eventId,
boolean match)
Sets the composed event
Id for this query. |
void |
matchScheduleId(Id scheduleId,
boolean match)
Sets the schedule
Id for this query for matching
schedules. |
void |
matchSpecificMeetingTime(DateTime start,
DateTime end,
boolean match)
Matches recurring events with specific dates between the given range
inclusive.
|
void |
matchSponsorId(Id sponsorId,
boolean match)
Sets the sponsor
Id for this query. |
void |
matchSupersedingEventId(Id supersedingEventId,
boolean match)
Sets the superseding event
Id for this query. |
boolean |
supportsCalendarQuery()
Tests if a
CalendarQuery is available for querying
calendars. |
boolean |
supportsEventQuery()
Tests if an
EventQuery is available for querying
composed events. |
boolean |
supportsScheduleQuery()
Tests if a
ScheduleQuery is available for querying
schedules. |
boolean |
supportsSponsorQuery()
Tests if a
LocationQuery is available for querying
sponsors. |
boolean |
supportsSupersedingEventQuery()
Tests if a
SupersedingEventQuery is available for
querying superseding events. |
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
clearSequesteredTerms, matchSequestered
void matchScheduleId(Id scheduleId, boolean match)
Id
for this query for matching
schedules.scheduleId
- a schedule Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- scheduleId
is
null
mandatory
- This method must be implemented. void clearScheduleIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsScheduleQuery()
ScheduleQuery
is available for querying
schedules. true
if a schedule query is available,
false
otherwisemandatory
- This method must be implemented. ScheduleQuery getScheduleQuery()
OR
term.UnimplementedException
- supportsScheduleQuery()
is false
optional
- This method must be implemented if
supportsScheduleQuery()
is true.
void matchAnySchedule(boolean match)
match
- true
to match recurring events with any
schedules, false
to match recurring events with
no schedulesmandatory
- This method must be implemented. void clearScheduleTerms()
mandatory
- This method must be implemented. void matchSupersedingEventId(Id supersedingEventId, boolean match)
Id
for this query.supersedingEventId
- a superseding event Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- supersedingEventId
is null
mandatory
- This method must be implemented. void clearSupersedingEventIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsSupersedingEventQuery()
SupersedingEventQuery
is available for
querying superseding events. true
if a superseding event query is available,
false
otherwisemandatory
- This method must be implemented. SupersedingEventQuery getSupersedingEventQuery()
OR
term.UnimplementedException
-
supportsSupersedingEventQuery()
is false
optional
- This method must be implemented if
supportsSupersedingEventQuery()
is true.
void matchAnySupersedingEvent(boolean match)
match
- true
to match recurring events with any
superseding events, false
to match events with
no superseding eventsmandatory
- This method must be implemented. void clearSupersedingEventTerms()
mandatory
- This method must be implemented. void matchSpecificMeetingTime(DateTime start, DateTime end, boolean match)
start
- start dateend
- end datematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- end
is less
than start
NullArgumentException
- start
or
end
is zero
mandatory
- This method must be implemented. void matchAnySpecificMeetingTime(boolean match)
match
- true
to match recurring events with any
specific date, false
to match recurring events
with no specific datemandatory
- This method must be implemented. void clearSpecificMeetingTimeTerms()
mandatory
- This method must be implemented. void matchEventId(Id eventId, boolean match)
Id
for this query.eventId
- an event Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- eventId
is
null
mandatory
- This method must be implemented. void clearEventIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsEventQuery()
EventQuery
is available for querying
composed events. true
if an event query is available,
false
otherwisemandatory
- This method must be implemented. EventQuery getEventQuery()
OR
term.UnimplementedException
- supportsEventQuery()
is false
optional
- This method must be implemented if
supportsEventQuery()
is true.
void matchAnyEvent(boolean match)
match
- true
to match recurring events with any
composed events, false
to match events with no
composed eventsmandatory
- This method must be implemented. void clearEventTerms()
mandatory
- This method must be implemented. void matchBlackout(DateTime datetime, boolean match)
datetime
- a datetimematch
- true
for a positive match, false
for a negative matchNullArgumentException
- datetime
is
null
mandatory
- This method must be implemented. void matchAnyBlackout(boolean match)
match
- true
to match recurring events with any
blackout, false
to match recurring events with
no blackoutmandatory
- This method must be implemented. void clearBlackoutTerms()
mandatory
- This method must be implemented. void matchBlackoutInclusive(DateTime start, DateTime end, boolean match)
start
- start dateend
- end datematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- end
is less
than start
NullArgumentException
- start
or
end
is zero
mandatory
- This method must be implemented. void clearBlackoutInclusiveTerms()
mandatory
- This method must be implemented. void matchSponsorId(Id sponsorId, boolean match)
Id
for this query.sponsorId
- a sponsor Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- sponsorId
is
null
mandatory
- This method must be implemented. void clearSponsorIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsSponsorQuery()
LocationQuery
is available for querying
sponsors. true
if a sponsor query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getSponsorQuery()
OR
term.UnimplementedException
- supportsSponsorQuery()
is false
optional
- This method must be implemented if
supportsSponsorQuery()
is true.
void clearSponsorTerms()
mandatory
- This method must be implemented. void matchCalendarId(Id calendarId, boolean match)
Id
for this query.calendarId
- a 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
terms.mandatory
- This method must be implemented. boolean supportsCalendarQuery()
CalendarQuery
is available for querying
calendars. 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. RecurringEventQueryRecord getRecurringEventQueryRecord(Type recurringEventRecordType) throws OperationFailedException
RecurringEvent
record Type.
Multiple retrievals
produce a nested OR
term.recurringEventRecordType
- a recurring event query record typeNullArgumentException
- recurringEventRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(recurringEventRecordType)
is
false
mandatory
- This method must be implemented.