org.osid.calendaring.rules

Interface OffsetEventEnablerQuery

All Superinterfaces:

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

public interface OffsetEventEnablerQuery
extends OsidEnablerQuery

This is the query for searching offset 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	clearRuledOffsetEventIdTerms() Clears the offset event Id query terms.
void	clearRuledOffsetEventTerms() Clears the offset event query terms.
CalendarQuery	getCalendarQuery() Gets the query for a calendar.
OffsetEventEnablerQueryRecord	getOffsetEventEnablerQueryRecord(Type offsetEventEnablerRecordType) Gets the offset event enabler query record corresponding to the given OffsetEventEnabler record Type.
OffsetEventQuery	getRuledOffsetEventQuery() Gets the query for an offset event.
void	matchAnyRuledOffsetEvent(boolean match) Matches enablers mapped to any offset event.
void	matchCalendarId(Id calendarId, boolean match) Matches enablers mapped to the calendar.
void	matchRuledOffsetEventId(Id offsetEventId, boolean match) Matches enablers mapped to the offset event.
boolean	supportsCalendarQuery() Tests if a CalendarQuery is available.
boolean	supportsRuledOffsetEventQuery() Tests if an OffsetEventQuery 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

matchRuledOffsetEventId

void matchRuledOffsetEventId(Id offsetEventId,
                           boolean match)

Matches enablers mapped to the offset event.

Parameters:

offsetEventId - the offset event Id

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

Throws:

NullArgumentException - offsetEventId is null

Compliance:

mandatory - This method must be implemented.

clearRuledOffsetEventIdTerms

void clearRuledOffsetEventIdTerms()

Clears the offset event Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledOffsetEventQuery

boolean supportsRuledOffsetEventQuery()

Tests if an OffsetEventQuery is available.

Returns:

true if an offset event query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledOffsetEventQuery

OffsetEventQuery getRuledOffsetEventQuery()

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

Returns:

the offset event query

Throws:

UnimplementedException - supportsRuledOffsetEventQuery() is false

Compliance:

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

matchAnyRuledOffsetEvent

void matchAnyRuledOffsetEvent(boolean match)

Matches enablers mapped to any offset event.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRuledOffsetEventTerms

void clearRuledOffsetEventTerms()

Clears the offset 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.

getOffsetEventEnablerQueryRecord

OffsetEventEnablerQueryRecord getOffsetEventEnablerQueryRecord(Type offsetEventEnablerRecordType)
                                                               throws OperationFailedException

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

Parameters:

offsetEventEnablerRecordType - an offset event enabler record type

Returns:

the offset event enabler query record

Throws:

NullArgumentException - offsetEventEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(offsetEventEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.