public interface OffsetEventQuery extends OsidRuleQuery
This is the query for searching 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 |
clearCalendarIdTerms()
Clears the calendar
Id terms. |
void |
clearCalendarTerms()
Clears the calendar terms.
|
void |
clearEndReferenceEventIdTerms()
Clears the end reference event
Id terms. |
void |
clearEndReferenceEventTerms()
Clears the end reference event terms.
|
void |
clearFixedDurationTerms()
Clears the fixed duration offset terms.
|
void |
clearFixedEndOffsetTerms()
Clears the fixed offset terms.
|
void |
clearFixedStartOffsetTerms()
Clears the fixed offset terms.
|
void |
clearFixedStartTimeTerms()
Clears the fixed start time terms.
|
void |
clearLocationDescriptionTerms()
Clears the location description terms.
|
void |
clearLocationIdTerms()
Clears the location
Id terms. |
void |
clearLocationTerms()
Clears the location terms.
|
void |
clearRelativeEndWeekdayTerms()
Clears the relative weekday terms.
|
void |
clearRelativeStartWeekdayTerms()
Clears the relative weekday terms.
|
void |
clearRelativeWeekdayEndOffsetTerms()
Clears the relative weekday offset terms.
|
void |
clearRelativeWeekdayStartOffsetTerms()
Clears the relative weekday offset terms.
|
void |
clearSponsorIdTerms()
Clears the sponsor
Id terms. |
void |
clearSponsorTerms()
Clears the sponsor terms.
|
void |
clearStartReferenceEventIdTerms()
Clears the start reference event
Id terms. |
void |
clearStartReferenceEventTerms()
Clears the start reference event terms.
|
CalendarQuery |
getCalendarQuery()
Gets the query for a calendar.
|
EventQuery |
getEndReferenceEventQuery()
Gets the query for the end reference event.
|
LocationQuery |
getLocationQuery()
Gets the query for a location.
|
OffsetEventQueryRecord |
getOffsetEventQueryRecord(Type offsetEventRecordType)
Gets the offset event query record corresponding to the given
OffsetEvent record Type. |
ResourceQuery |
getSponsorQuery()
Gets the query for a sponsor.
|
EventQuery |
getStartReferenceEventQuery()
Gets the query for the start reference event.
|
void |
matchAnyEndReferenceEvent(boolean match)
Matches any end reference event events.
|
void |
matchAnyFixedEndOffset(boolean match)
Matches fixed offset events.
|
void |
matchAnyFixedStartOffset(boolean match)
Matches fixed offset events.
|
void |
matchAnyFixedStartTime(boolean match)
Matches events with fixed start times.
|
void |
matchAnyLocation(boolean match)
Matches an event that has any location assigned.
|
void |
matchAnyLocationDescription(boolean match)
Matches an event that has any location description assigned.
|
void |
matchAnyRelativeEndWeekday(boolean match)
Matches relative weekday offset events.
|
void |
matchAnyRelativeStartWeekday(boolean match)
Matches relative weekday offset events.
|
void |
matchAnyStartReferenceEvent(boolean match)
Matches offset events with any starting reference event.
|
void |
matchCalendarId(Id calendarId,
boolean match)
Sets the calendar
Id for this query. |
void |
matchEndReferenceEventId(Id eventId,
boolean match)
Sets the end reference event
Id for this query. |
void |
matchFixedDuration(Duration low,
Duration high,
boolean match)
Matches a fixed duration between the given range inclusive.
|
void |
matchFixedEndOffset(Duration from,
Duration to,
boolean match)
Matches a fixed offset amount between the given range inclusive.
|
void |
matchFixedStartOffset(Duration from,
Duration to,
boolean match)
Matches a fixed offset amount between the given range inclusive.
|
void |
matchFixedStartTime(DateTime from,
DateTime to,
boolean match)
Matches a fixed start time between the given range inclusive.
|
void |
matchLocationDescription(java.lang.String location,
Type stringMatchType,
boolean match)
Matches the location description string.
|
void |
matchLocationId(Id locationId,
boolean match)
Sets the location
Id for this query. |
void |
matchRelativeEndWeekday(long weekday,
boolean match)
Matches a relative weekday.
|
void |
matchRelativeStartWeekday(long weekday,
boolean match)
Matches a relative weekday.
|
void |
matchRelativeWeekdayEndOffset(long low,
long high,
boolean match)
Matches a relative weekday offset amount between the given range
inclusive.
|
void |
matchRelativeWeekdayStartOffset(long low,
long high,
boolean match)
Matches a relative weekday offset amount between the given range
inclusive.
|
void |
matchSponsorId(Id sponsorId,
boolean match)
Sets the sponsor
Id for this query. |
void |
matchStartReferenceEventId(Id eventId,
boolean match)
Sets the start reference event
Id for this query. |
boolean |
supportsCalendarQuery()
Tests if a
CalendarQuery is available for querying
calendars. |
boolean |
supportsEndReferenceEventQuery()
Tests if an
EventQuery is available for querying end
reference event terms. |
boolean |
supportsLocationQuery()
Tests if a
LocationQuery is available for querying
locations. |
boolean |
supportsSponsorQuery()
Tests if a
LocationQuery is available for querying
sponsors. |
boolean |
supportsStartReferenceEventQuery()
Tests if an
EventQuery is available for querying start
reference event terms. |
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
void matchFixedStartTime(DateTime from, DateTime to, boolean match)
from
- the start of the rangeto
- the end of the rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- to
is less
than from
NullArgumentException
- from
or
to
null
mandatory
- This method must be implemented. void matchAnyFixedStartTime(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearFixedStartTimeTerms()
mandatory
- This method must be implemented. void matchStartReferenceEventId(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 clearStartReferenceEventIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsStartReferenceEventQuery()
EventQuery
is available for querying start
reference event terms. true
if an event query is available,
false
otherwisemandatory
- This method must be implemented. EventQuery getStartReferenceEventQuery()
OR
term.UnimplementedException
-
supportsStartReferenceEventQuery()
is false
optional
- This method must be implemented if
supportsStartReferenceEventQuery()
is true.
void matchAnyStartReferenceEvent(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearStartReferenceEventTerms()
mandatory
- This method must be implemented. void matchFixedStartOffset(Duration from, Duration to, boolean match)
from
- the start of the rangeto
- the end of the rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- to
is less
than from
NullArgumentException
- from
or
to
null
mandatory
- This method must be implemented. void matchAnyFixedStartOffset(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearFixedStartOffsetTerms()
mandatory
- This method must be implemented. void matchRelativeWeekdayStartOffset(long low, long high, boolean match)
low
- the start of the rangehigh
- the end of the rangematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearRelativeWeekdayStartOffsetTerms()
mandatory
- This method must be implemented. void matchRelativeStartWeekday(long weekday, boolean match)
weekday
- the weekdaymatch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyRelativeStartWeekday(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearRelativeStartWeekdayTerms()
mandatory
- This method must be implemented. void matchFixedDuration(Duration low, Duration high, boolean match)
low
- the start of the rangehigh
- the end of the rangematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearFixedDurationTerms()
mandatory
- This method must be implemented. void matchEndReferenceEventId(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 clearEndReferenceEventIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsEndReferenceEventQuery()
EventQuery
is available for querying end
reference event terms. true
if an event query is available,
false
otherwisemandatory
- This method must be implemented. EventQuery getEndReferenceEventQuery()
OR
term.UnimplementedException
-
supportsEventReferenceEventQuery()
is false
optional
- This method must be implemented if
supportsEndReferenceEventQuery()
is true.
void matchAnyEndReferenceEvent(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearEndReferenceEventTerms()
mandatory
- This method must be implemented. void matchFixedEndOffset(Duration from, Duration to, boolean match)
from
- the start of the rangeto
- the end of the rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- to
is less
than from
NullArgumentException
- from
or
to
null
mandatory
- This method must be implemented. void matchAnyFixedEndOffset(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearFixedEndOffsetTerms()
mandatory
- This method must be implemented. void matchRelativeWeekdayEndOffset(long low, long high, boolean match)
low
- the start of the rangehigh
- the end of the rangematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearRelativeWeekdayEndOffsetTerms()
mandatory
- This method must be implemented. void matchRelativeEndWeekday(long weekday, boolean match)
weekday
- the weekdaymatch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyRelativeEndWeekday(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearRelativeEndWeekdayTerms()
mandatory
- This method must be implemented. void matchLocationDescription(java.lang.String location, Type stringMatchType, boolean match)
location
- location stringstringMatchType
- string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- location
is
not of stringMatchType
NullArgumentException
- location
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyLocationDescription(boolean match)
match
- true
to match events with any location
description, false
to match events with no
location descriptionmandatory
- This method must be implemented. void clearLocationDescriptionTerms()
mandatory
- This method must be implemented. void matchLocationId(Id locationId, boolean match)
Id
for this query.locationId
- a location Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- locationId
is
null
mandatory
- This method must be implemented. void clearLocationIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsLocationQuery()
LocationQuery
is available for querying
locations. true
if a location query is available,
false
otherwisemandatory
- This method must be implemented. LocationQuery getLocationQuery()
OR
term.UnimplementedException
- supportsLocationQuery()
is false
optional
- This method must be implemented if
supportsLocationQuery()
is true.
void matchAnyLocation(boolean match)
match
- true
to match events with any location,
false
to match events with no locationmandatory
- This method must be implemented. void clearLocationTerms()
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. OffsetEventQueryRecord getOffsetEventQueryRecord(Type offsetEventRecordType) throws OperationFailedException
OffsetEvent
record Type.
Multiple retrievals
produce a nested OR
term.offsetEventRecordType
- an offset event query record typeNullArgumentException
- offsetEventRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(offsetEventRecordType)
is false
mandatory
- This method must be implemented.