Interface OffsetEventQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, Suppliable

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 .

Method Summary

Modifier and Type	Method	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(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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface OsidObjectQuery

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Modifier and Type	Method	Description
void	clearActiveTerms()	Clears the active query terms.
void	clearDisabledTerms()	Clears the administratively disabled query terms.
void	clearEnabledTerms()	Clears the administratively enabled query terms.
void	clearOperationalTerms()	Clears the operational query terms.
void	matchActive(boolean match)	Matches active.
void	matchDisabled(boolean match)	Matches administratively disabled.
void	matchEnabled(boolean match)	Matches administratively enabled.
void	matchOperational(boolean match)	Matches operational operables.

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidRuleQuery

clearConditionRecordTypeTerms, clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyConditionRecordType, matchAnyRule, matchConditionRecordType, matchRuleId, supportsRuleQuery

Modifier and Type	Method	Description
void	clearConditionRecordTypeTerms()	Clears the condition record Type query terms.
void	clearRuleIdTerms()	Clears all rule Id terms.
void	clearRuleTerms()	Clears all rule terms.
RuleQuery	getRuleQuery(boolean match)	Gets the query for the rule.
void	matchAnyConditionRecordType(boolean match)	Matches rules with any condition record type.
void	matchAnyRule(boolean match)	Match any associated rule.
void	matchConditionRecordType(Type conditionRecordType, boolean match)	Matches a condition record type.
void	matchRuleId(Id ruleId, boolean match)	Match the Id of the rule.
boolean	supportsRuleQuery()	Tests if a RuleQuery for the rule is available.

Method Details

matchFixedStartTime

void matchFixedStartTime(DateTime from,
 DateTime to,
 boolean match)

Matches a fixed start time between the given range inclusive.

Parameters:

from - the start of the range

to - the end of the range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - to is less than from

NullArgumentException - from or to null

Compliance:

mandatory - This method must be implemented.

matchAnyFixedStartTime

void matchAnyFixedStartTime(boolean match)

Matches events with fixed start times.

Parameters:

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearFixedStartTimeTerms

void clearFixedStartTimeTerms()

Clears the fixed start time terms.

Compliance:

mandatory - This method must be implemented.

matchStartReferenceEventId

void matchStartReferenceEventId(Id eventId,
 boolean match)

Sets the start reference event Id for this query.

Parameters:

eventId - an event Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - eventId is null

Compliance:

mandatory - This method must be implemented.

clearStartReferenceEventIdTerms

void clearStartReferenceEventIdTerms()

Clears the start reference event Id terms.

Compliance:

mandatory - This method must be implemented.

supportsStartReferenceEventQuery

boolean supportsStartReferenceEventQuery()

Tests if an EventQuery is available for querying start reference event terms.

Returns:

true if an event query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStartReferenceEventQuery

EventQuery getStartReferenceEventQuery()

Gets the query for the start reference event. Multiple retrievals produce a nested OR term.

Returns:

the event query

Throws:

UnimplementedException - supportsStartReferenceEventQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsStartReferenceEventQuery()} is {@code true} .

matchAnyStartReferenceEvent

void matchAnyStartReferenceEvent(boolean match)

Matches offset events with any starting reference event.

Parameters:

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearStartReferenceEventTerms

void clearStartReferenceEventTerms()

Clears the start reference event terms.

Compliance:

mandatory - This method must be implemented.

matchFixedStartOffset

void matchFixedStartOffset(Duration from,
 Duration to,
 boolean match)

Matches a fixed offset amount between the given range inclusive.

Parameters:

from - the start of the range

to - the end of the range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - to is less than from

NullArgumentException - from or to null

Compliance:

mandatory - This method must be implemented.

matchAnyFixedStartOffset

void matchAnyFixedStartOffset(boolean match)

Matches fixed offset events.

Parameters:

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearFixedStartOffsetTerms

void clearFixedStartOffsetTerms()

Clears the fixed offset terms.

Compliance:

mandatory - This method must be implemented.

matchRelativeWeekdayStartOffset

void matchRelativeWeekdayStartOffset(long low,
 long high,
 boolean match)

Matches a relative weekday offset amount between the given range inclusive.

Parameters:

low - the start of the range

high - the end of the range

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearRelativeWeekdayStartOffsetTerms

void clearRelativeWeekdayStartOffsetTerms()

Clears the relative weekday offset terms.

Compliance:

mandatory - This method must be implemented.

matchRelativeStartWeekday

void matchRelativeStartWeekday(long weekday,
 boolean match)

Matches a relative weekday.

Parameters:

weekday - the weekday

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

matchAnyRelativeStartWeekday

void matchAnyRelativeStartWeekday(boolean match)

Matches relative weekday offset events.

Parameters:

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearRelativeStartWeekdayTerms

void clearRelativeStartWeekdayTerms()

Clears the relative weekday terms.

Compliance:

mandatory - This method must be implemented.

matchFixedDuration

void matchFixedDuration(Duration low,
 Duration high,
 boolean match)

Matches a fixed duration between the given range inclusive.

Parameters:

low - the start of the range

high - the end of the range

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearFixedDurationTerms

void clearFixedDurationTerms()

Clears the fixed duration offset terms.

Compliance:

mandatory - This method must be implemented.

matchEndReferenceEventId

void matchEndReferenceEventId(Id eventId,
 boolean match)

Sets the end reference event Id for this query.

Parameters:

eventId - an event Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - eventId is null

Compliance:

mandatory - This method must be implemented.

clearEndReferenceEventIdTerms

void clearEndReferenceEventIdTerms()

Clears the end reference event Id terms.

Compliance:

mandatory - This method must be implemented.

supportsEndReferenceEventQuery

boolean supportsEndReferenceEventQuery()

Tests if an EventQuery is available for querying end reference event terms.

Returns:

true if an event query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEndReferenceEventQuery

EventQuery getEndReferenceEventQuery()

Gets the query for the end reference event. Multiple retrievals produce a nested OR term.

Returns:

the event query

Throws:

UnimplementedException - supportsEventReferenceEventQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsEndReferenceEventQuery()} is {@code true} .

matchAnyEndReferenceEvent

void matchAnyEndReferenceEvent(boolean match)

Matches any end reference event events.

Parameters:

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearEndReferenceEventTerms

void clearEndReferenceEventTerms()

Clears the end reference event terms.

Compliance:

mandatory - This method must be implemented.

matchFixedEndOffset

void matchFixedEndOffset(Duration from,
 Duration to,
 boolean match)

Matches a fixed offset amount between the given range inclusive.

Parameters:

from - the start of the range

to - the end of the range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - to is less than from

NullArgumentException - from or to null

Compliance:

mandatory - This method must be implemented.

matchAnyFixedEndOffset

void matchAnyFixedEndOffset(boolean match)

Matches fixed offset events.

Parameters:

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearFixedEndOffsetTerms

void clearFixedEndOffsetTerms()

Clears the fixed offset terms.

Compliance:

mandatory - This method must be implemented.

matchRelativeWeekdayEndOffset

void matchRelativeWeekdayEndOffset(long low,
 long high,
 boolean match)

Matches a relative weekday offset amount between the given range inclusive.

Parameters:

low - the start of the range

high - the end of the range

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearRelativeWeekdayEndOffsetTerms

void clearRelativeWeekdayEndOffsetTerms()

Clears the relative weekday offset terms.

Compliance:

mandatory - This method must be implemented.

matchRelativeEndWeekday

void matchRelativeEndWeekday(long weekday,
 boolean match)

Matches a relative weekday.

Parameters:

weekday - the weekday

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

matchAnyRelativeEndWeekday

void matchAnyRelativeEndWeekday(boolean match)

Matches relative weekday offset events.

Parameters:

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearRelativeEndWeekdayTerms

void clearRelativeEndWeekdayTerms()

Clears the relative weekday terms.

Compliance:

mandatory - This method must be implemented.

matchLocationDescription

void matchLocationDescription(String location,
 Type stringMatchType,
 boolean match)

Matches the location description string.

Parameters:

location - location string

stringMatchType - string match type

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - location is not of stringMatchType

NullArgumentException - location or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyLocationDescription

void matchAnyLocationDescription(boolean match)

Matches an event that has any location description assigned.

Parameters:

match - true to match events with any location description, false to match events with no location description

Compliance:

mandatory - This method must be implemented.

clearLocationDescriptionTerms

void clearLocationDescriptionTerms()

Clears the location description terms.

Compliance:

mandatory - This method must be implemented.

matchLocationId

void matchLocationId(Id locationId,
 boolean match)

Sets the location Id for this query.

Parameters:

locationId - a location Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - locationId is null

Compliance:

mandatory - This method must be implemented.

clearLocationIdTerms

void clearLocationIdTerms()

Clears the location Id terms.

Compliance:

mandatory - This method must be implemented.

supportsLocationQuery

boolean supportsLocationQuery()

Tests if a LocationQuery is available for querying locations.

Returns:

true if a location query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLocationQuery

LocationQuery getLocationQuery()

Gets the query for a location. Multiple retrievals produce a nested OR term.

Returns:

the location query

Throws:

UnimplementedException - supportsLocationQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationQuery()} is {@code true} .

matchAnyLocation

void matchAnyLocation(boolean match)

Matches an event that has any location assigned.

Parameters:

match - true to match events with any location, false to match events with no location

Compliance:

mandatory - This method must be implemented.

clearLocationTerms

void clearLocationTerms()

Clears the location terms.

Compliance:

mandatory - This method must be implemented.

matchSponsorId

void matchSponsorId(Id sponsorId,
 boolean match)

Sets the sponsor Id for this query.

Parameters:

sponsorId - a sponsor Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - sponsorId is null

Compliance:

mandatory - This method must be implemented.

clearSponsorIdTerms

void clearSponsorIdTerms()

Clears the sponsor Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSponsorQuery

boolean supportsSponsorQuery()

Tests if a LocationQuery is available for querying sponsors.

Returns:

true if a sponsor query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSponsorQuery

ResourceQuery getSponsorQuery()

Gets the query for a sponsor. Multiple retrievals produce a nested OR term.

Returns:

the sponsor query

Throws:

UnimplementedException - supportsSponsorQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSponsorQuery()} is {@code true} .

clearSponsorTerms

void clearSponsorTerms()

Clears the sponsor terms.

Compliance:

mandatory - This method must be implemented.

matchCalendarId

void matchCalendarId(Id calendarId,
 boolean match)

Sets the calendar Id for this query.

Parameters:

calendarId - a calendar Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - calendarId is null

Compliance:

mandatory - This method must be implemented.

clearCalendarIdTerms

void clearCalendarIdTerms()

Clears the calendar Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCalendarQuery

boolean supportsCalendarQuery()

Tests if a CalendarQuery is available for querying calendars.

Returns:

true if a calendar query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCalendarQuery

CalendarQuery getCalendarQuery()

Gets the query for a calendar. Multiple retrievals produce a nested OR term.

Returns:

the calendar query

Throws:

UnimplementedException - supportsCalendarQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCalendarQuery()} is {@code true} .

clearCalendarTerms

void clearCalendarTerms()

Clears the calendar terms.

Compliance:

mandatory - This method must be implemented.

getOffsetEventQueryRecord

OffsetEventQueryRecord getOffsetEventQueryRecord(Type offsetEventRecordType)
                                          throws OperationFailedException

Gets the offset event query record corresponding to the given OffsetEvent record Type . Multiple retrievals produce a nested OR term.

Parameters:

offsetEventRecordType - an offset event query record type

Returns:

the offset event query record

Throws:

NullArgumentException - offsetEventRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(offsetEventRecordType) is false

Compliance:

mandatory - This method must be implemented.