org.osid.calendaring

Interface SupersedingEventQuery

All Superinterfaces:

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

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.

Method Summary

Methods

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.

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

matchSupersededEventId

void matchSupersededEventId(Id eventId,
                          boolean match)

Sets the event Id for this query for matching attached events.

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.

clearSupersededEventIdTerms

void clearSupersededEventIdTerms()

Clears the event Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSupersededEventQuery

boolean supportsSupersededEventQuery()

Tests if an EventQuery is available for querying attached events.

Returns:

true if an event query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSupersededEventQuery

EventQuery getSupersededEventQuery()

Gets the query for an attached event. Multiple retrievals produce a nested OR term.

Returns:

the event query

Throws:

UnimplementedException - supportsSupersededEventQuery() is false

Compliance:

optional - This method must be implemented if supportsSupersededEventQuery() is true.

clearSupersededEventTerms

void clearSupersededEventTerms()

Clears the event terms.

Compliance:

mandatory - This method must be implemented.

matchSupersedingEventId

void matchSupersedingEventId(Id supersedingEventId,
                           boolean match)

Sets the superseding event Id for this query.

Parameters:

supersedingEventId - a superseding event Id

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

Throws:

NullArgumentException - supersedingEventId is null

Compliance:

mandatory - This method must be implemented.

clearSupersedingEventIdTerms

void clearSupersedingEventIdTerms()

Clears the superseding event Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSupersedingEventQuery

boolean supportsSupersedingEventQuery()

Tests if a SupersedingEventQuery is available.

Returns:

true if a superseding event query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSupersedingEventQuery

EventQuery getSupersedingEventQuery()

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

Returns:

the superseding event query

Throws:

UnimplementedException - supportsSupersedingEventQuery() is false

Compliance:

optional - This method must be implemented if supportsSupersedingEventQuery() is true.

clearSupersedingEventTerms

void clearSupersedingEventTerms()

Clears the superseding event terms.

Compliance:

mandatory - This method must be implemented.

matchSupersededDate

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

Matches superseding events that supersede within the given dates inclusive.

Parameters:

from - start date

to - end date

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

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnySupersededDate

void matchAnySupersededDate(boolean match)

Matches a superseding event that has any superseded date.

Parameters:

match - true to match superseding events with any superseded date, false to match superseding events with no superseded date

Compliance:

mandatory - This method must be implemented.

clearSupersededDateTerms

void clearSupersededDateTerms()

Clears the superseded date terms.

Compliance:

mandatory - This method must be implemented.

matchSupersededEventPosition

void matchSupersededEventPosition(long from,
                                long to,
                                boolean match)

Matches superseding events that supersede within the denormalized event positions inclusive.

Parameters:

from - start position

to - end position

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

Throws:

InvalidArgumentException - the absolute value of from is greater than to

Compliance:

mandatory - This method must be implemented.

matchAnySupersededEventPosition

void matchAnySupersededEventPosition(boolean match)

Matches a superseding event that has any superseded position.

Parameters:

match - true to match superseding events with any superseded event position, false to match superseding events with no superseded event position

Compliance:

mandatory - This method must be implemented.

clearSupersededEventPositionTerms

void clearSupersededEventPositionTerms()

Clears the superseded position 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.

getSupersedingEventQueryRecord

SupersedingEventQueryRecord getSupersedingEventQueryRecord(Type supersedingEventRecordType)
                                                           throws OperationFailedException

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

Parameters:

supersedingEventRecordType - a superseding event query record type

Returns:

the superseding event query record

Throws:

NullArgumentException - supersedingEventRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(supersedingEventRecordType) is false

Compliance:

mandatory - This method must be implemented.