org.osid.calendaring

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

Methods

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.

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

Methods inherited from interface org.osid.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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

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

Method Detail

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 supportsStartReferenceEventQuery() is 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 supportsEndReferenceEventQuery() is 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(java.lang.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 supportsLocationQuery() is 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 supportsSponsorQuery() is 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 supportsCalendarQuery() is 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.