org.osid.calendaring.rules

Interface SupersedingEventEnablerQuery

All Superinterfaces:

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

public interface SupersedingEventEnablerQuery
extends OsidEnablerQuery

This is the query for searching superseding event enablers. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCalendarIdTerms() Clears the calendar Id query terms.
void	clearCalendarTerms() Clears the calendar query terms.
void	clearRuledSupersedingEventIdTerms() Clears the superseding event Id query terms.
void	clearRuledSupersedingEventTerms() Clears the calendar query terms.
CalendarQuery	getCalendarQuery() Gets the query for a calendar.
SupersedingEventQuery	getRuledSupersedingEventQuery() Gets the query for a supsreding event.
SupersedingEventEnablerQueryRecord	getSupersedingEventEnablerQueryRecord(Type supersedingEventEnablerRecordType) Gets the superseding event enabler query record corresponding to the given SupersedingEventEnabler record Type.
void	matchAnyRuledSupersedingEvent(boolean match) Matches enablers mapped to any supsreding event.
void	matchCalendarId(Id calendarId, boolean match) Matches enablers mapped to the calendar.
void	matchRuledSupersedingEventId(Id supersedingEventId, boolean match) Matches enablers mapped to the superseding event.
boolean	supportsCalendarQuery() Tests if a CalendarQuery is available.
boolean	supportsRuledSupersedingEventQuery() Tests if an SupersedingEventQuery is available.

Methods inherited from interface org.osid.OsidEnablerQuery

clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery

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

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchRuledSupersedingEventId

void matchRuledSupersedingEventId(Id supersedingEventId,
                                boolean match)

Matches enablers mapped to the superseding event.

Parameters:

supersedingEventId - the 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.

clearRuledSupersedingEventIdTerms

void clearRuledSupersedingEventIdTerms()

Clears the superseding event Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledSupersedingEventQuery

boolean supportsRuledSupersedingEventQuery()

Tests if an SupersedingEventQuery is available.

Returns:

true if a superseding event query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledSupersedingEventQuery

SupersedingEventQuery getRuledSupersedingEventQuery()

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

Returns:

the superseding event query

Throws:

UnimplementedException - supportsRuledSupersedingEventQuery() is false

Compliance:

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

matchAnyRuledSupersedingEvent

void matchAnyRuledSupersedingEvent(boolean match)

Matches enablers mapped to any supsreding event.

Parameters:

match - true for enablers mapped to any supsreding event, false to match enablers mapped to no supsreding events

Compliance:

mandatory - This method must be implemented.

clearRuledSupersedingEventTerms

void clearRuledSupersedingEventTerms()

Clears the calendar query terms.

Compliance:

mandatory - This method must be implemented.

matchCalendarId

void matchCalendarId(Id calendarId,
                   boolean match)

Matches enablers mapped to the calendar.

Parameters:

calendarId - the 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 query terms.

Compliance:

mandatory - This method must be implemented.

supportsCalendarQuery

boolean supportsCalendarQuery()

Tests if a CalendarQuery is available.

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 query terms.

Compliance:

mandatory - This method must be implemented.

getSupersedingEventEnablerQueryRecord

SupersedingEventEnablerQueryRecord getSupersedingEventEnablerQueryRecord(Type supersedingEventEnablerRecordType)
                                                                         throws OperationFailedException

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

Parameters:

supersedingEventEnablerRecordType - a superseding event enabler record type

Returns:

the superseding event enabler query record

Throws:

NullArgumentException - supersedingEventEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(supersedingEventEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.