public interface CyclicEventQuery extends OsidObjectQuery
This is the query for searching cyclic 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 |
clearEventIdTerms()
Clears the event terms.
|
void |
clearEventTerms()
Clears the event terms.
|
CalendarQuery |
getCalendarQuery()
Gets the query for a calendar.
|
CyclicEventQueryRecord |
getCyclicEventQueryRecord(Type cyclicEventRecordType)
Gets the cyclic event query record corresponding to the given
CyclicEvent record Type. |
EventQuery |
getEventQuery()
Gets the query for an event.
|
void |
matchAnyEvent(boolean match)
Matches a cyclic event that has any related event.
|
void |
matchCalendarId(Id calendarId,
boolean match)
Sets the calendar
Id for this query. |
void |
matchEventId(Id eventId,
boolean match)
Matches cyclic events that are related to the given event.
|
boolean |
supportsCalendarQuery()
Tests if a
CalendarQuery is available for querying
calendars. |
boolean |
supportsEventQuery()
Tests if an
EventQuery is available. |
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
void matchEventId(Id eventId, boolean match)
eventId
- an Id
for an eventmatch
- true
for a positive match, false
for a negative matchNullArgumentException
- eventId
is
null
mandatory
- This method must be implemented. void clearEventIdTerms()
mandatory
- This method must be implemented. boolean supportsEventQuery()
EventQuery
is available. 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 cyclic events with any
event, false
to match cyclic events with no
related eventsmandatory
- This method must be implemented. void clearEventTerms()
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. CyclicEventQueryRecord getCyclicEventQueryRecord(Type cyclicEventRecordType) throws OperationFailedException
CyclicEvent
record Type.
Multiple retrievals
produce a nested OR
term.cyclicEventRecordType
- a cyclic event query record typeNullArgumentException
- cyclicEventRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(cyclicEventRecordType)
is false
mandatory
- This method must be implemented.