org.osid.calendaring.rules

Interface RecurringEventEnablerQuery

All Superinterfaces:

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

public interface RecurringEventEnablerQuery
extends OsidEnablerQuery

This is the query for searching recurring 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	clearRuledRecurringEventIdTerms() Clears the recurring event Id query terms.
void	clearRuledRecurringEventTerms() Clears the recurring event query terms.
CalendarQuery	getCalendarQuery() Gets the query for a calendar.
RecurringEventEnablerQueryRecord	getRecurringEventEnablerQueryRecord(Type recurringEventEnablerRecordType) Gets the recurring event enabler query record corresponding to the given RecurringEventEnabler record Type.
RecurringEventQuery	getRuledRecurringEventQuery() Gets the query for a recurring event.
void	matchAnyRuledRecurringEvent(boolean match) Matches enablers mapped to any recurring event.
void	matchCalendarId(Id calendarId, boolean match) Matches enablers mapped to the calendar.
void	matchRuledRecurringEventId(Id recurringEventId, boolean match) Matches enablers mapped to the recurring event.
boolean	supportsCalendarQuery() Tests if a CalendarQuery is available.
boolean	supportsRuledRecurringEventQuery() Tests if a RecurringEventQuery 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

matchRuledRecurringEventId

void matchRuledRecurringEventId(Id recurringEventId,
                              boolean match)

Matches enablers mapped to the recurring event.

Parameters:

recurringEventId - the recurring event Id

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

Throws:

NullArgumentException - recurringEventId is null

Compliance:

mandatory - This method must be implemented.

clearRuledRecurringEventIdTerms

void clearRuledRecurringEventIdTerms()

Clears the recurring event Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledRecurringEventQuery

boolean supportsRuledRecurringEventQuery()

Tests if a RecurringEventQuery is available.

Returns:

true if a recurring event query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledRecurringEventQuery

RecurringEventQuery getRuledRecurringEventQuery()

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

Returns:

the recurring event query

Throws:

UnimplementedException - supportsRuledRecurringEventQuery() is false

Compliance:

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

matchAnyRuledRecurringEvent

void matchAnyRuledRecurringEvent(boolean match)

Matches enablers mapped to any recurring event.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRuledRecurringEventTerms

void clearRuledRecurringEventTerms()

Clears the recurring event 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.

getRecurringEventEnablerQueryRecord

RecurringEventEnablerQueryRecord getRecurringEventEnablerQueryRecord(Type recurringEventEnablerRecordType)
                                                                     throws OperationFailedException

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

Parameters:

recurringEventEnablerRecordType - a recurring event enabler record type

Returns:

the recurring event enabler query record

Throws:

NullArgumentException - recurringEventEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(recurringEventEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.