public interface SupersedingEventQuery extends OsidRuleQuery
This is the query for searching superseding 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 |
clearSupersededDateTerms()
Clears the superseded date terms.
|
void |
clearSupersededEventIdTerms()
Clears the event
Id terms. |
void |
clearSupersededEventPositionTerms()
Clears the superseded position terms.
|
void |
clearSupersededEventTerms()
Clears the event 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 |
getSupersededEventQuery()
Gets the query for an attached event.
|
EventQuery |
getSupersedingEventQuery()
Gets the query for a superseding event.
|
SupersedingEventQueryRecord |
getSupersedingEventQueryRecord(Type supersedingEventRecordType)
Gets the superseding event query record corresponding to the given
SupersedingEvent record Type. |
void |
matchAnySupersededDate(boolean match)
Matches a superseding event that has any superseded date.
|
void |
matchAnySupersededEventPosition(boolean match)
Matches a superseding event that has any superseded position.
|
void |
matchCalendarId(Id calendarId,
boolean match)
Sets the calendar
Id for this query. |
void |
matchSupersededDate(DateTime from,
DateTime to,
boolean match)
Matches superseding events that supersede within the given dates
inclusive.
|
void |
matchSupersededEventId(Id eventId,
boolean match)
Sets the event
Id for this query for matching attached
events. |
void |
matchSupersededEventPosition(long from,
long to,
boolean match)
Matches superseding events that supersede within the denormalized
event positions inclusive.
|
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 |
supportsSupersededEventQuery()
Tests if an
EventQuery is available for querying
attached events. |
boolean |
supportsSupersedingEventQuery()
Tests if a
SupersedingEventQuery is available. |
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 matchSupersededEventId(Id eventId, boolean match)
Id
for this query for matching attached
events.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 clearSupersededEventIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsSupersededEventQuery()
EventQuery
is available for querying
attached events. true
if an event query is available,
false
otherwisemandatory
- This method must be implemented. EventQuery getSupersededEventQuery()
OR
term.UnimplementedException
-
supportsSupersededEventQuery()
is false
optional
- This method must be implemented if
supportsSupersededEventQuery()
is true.
void clearSupersededEventTerms()
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. true
if a superseding event query is available,
false
otherwisemandatory
- This method must be implemented. EventQuery getSupersedingEventQuery()
OR
term.UnimplementedException
-
supportsSupersedingEventQuery()
is false
optional
- This method must be implemented if
supportsSupersedingEventQuery()
is true.
void clearSupersedingEventTerms()
mandatory
- This method must be implemented. void matchSupersededDate(DateTime from, DateTime to, boolean match)
from
- start dateto
- end datematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnySupersededDate(boolean match)
match
- true
to match superseding events with any
superseded date, false to match superseding events with no
superseded datemandatory
- This method must be implemented. void clearSupersededDateTerms()
mandatory
- This method must be implemented. void matchSupersededEventPosition(long from, long to, boolean match)
from
- start positionto
- end positionmatch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- the absolute value of
from
is greater than to
mandatory
- This method must be implemented. void matchAnySupersededEventPosition(boolean match)
match
- true
to match superseding events with any
superseded event position, false to match superseding events
with no superseded event positionmandatory
- This method must be implemented. void clearSupersededEventPositionTerms()
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. SupersedingEventQueryRecord getSupersedingEventQueryRecord(Type supersedingEventRecordType) throws OperationFailedException
SupersedingEvent
record Type.
Multiple
retrievals produce a nested OR
term.supersedingEventRecordType
- a superseding event query record
typeNullArgumentException
-
supersedingEventRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(supersedingEventRecordType)
is
false
mandatory
- This method must be implemented.