org.osid.calendaring.rules

Interface RecurringEventEnablerQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidEnablerQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector, OsidTemporalQueryInspector

public interface RecurringEventEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining recurring event enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getCalendarIdTerms() Gets the calendar Id query terms.
CalendarQueryInspector[]	getCalendarTerms() Gets the calendar query terms.
RecurringEventEnablerQueryInspectorRecord	getRecurringEventEnablerQueryInspectorRecord(Type recurringEventEnablerRecordType) Gets the recurring event enabler query inspector record corresponding to the given RecurringEventEnabler record Type.
IdTerm[]	getRuledRecurringEventIdTerms() Gets the recurring event Id query terms.
RecurringEventQueryInspector[]	getRuledRecurringEventTerms() Gets the recurring event query terms.

Methods inherited from interface org.osid.OsidEnablerQueryInspector

getCyclicEventIdTerms, getCyclicEventTerms, getDemographicIdTerms, getDemographicTerms, getEventIdTerms, getEventTerms, getScheduleIdTerms, getScheduleTerms

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getRuledRecurringEventIdTerms

IdTerm[] getRuledRecurringEventIdTerms()

Gets the recurring event Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledRecurringEventTerms

RecurringEventQueryInspector[] getRuledRecurringEventTerms()

Gets the recurring event query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCalendarIdTerms

IdTerm[] getCalendarIdTerms()

Gets the calendar Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCalendarTerms

CalendarQueryInspector[] getCalendarTerms()

Gets the calendar query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablerQueryInspectorRecord

RecurringEventEnablerQueryInspectorRecord getRecurringEventEnablerQueryInspectorRecord(Type recurringEventEnablerRecordType)
                                                                                       throws OperationFailedException

Gets the recurring event enabler query inspector record corresponding to the given RecurringEventEnabler record Type.

Parameters:

recurringEventEnablerRecordType - a recurring event enabler record type

Returns:

the recurring event enabler query inspector record

Throws:

NullArgumentException - recurringEventEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(recurringEventEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.