org.osid.calendaring.rules

Interface SupersedingEventEnablerQueryInspector

All Superinterfaces:

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

public interface SupersedingEventEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining superseding 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.
IdTerm[]	getRuledSupersedingEventIdTerms() Gets the superseding event Id query terms.
SupersedingEventQueryInspector[]	getRuledSupersedingEventTerms() Gets the superseding event query terms.
SupersedingEventEnablerQueryInspectorRecord	getSupersedingEventEnablerQueryInspectorRecord(Type supersedingEventEnablerRecordType) Gets the superseding event enabler query inspector record corresponding to the given SupersedingEventEnabler record Type.

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

getRuledSupersedingEventIdTerms

IdTerm[] getRuledSupersedingEventIdTerms()

Gets the superseding event Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledSupersedingEventTerms

SupersedingEventQueryInspector[] getRuledSupersedingEventTerms()

Gets the superseding 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.

getSupersedingEventEnablerQueryInspectorRecord

SupersedingEventEnablerQueryInspectorRecord getSupersedingEventEnablerQueryInspectorRecord(Type supersedingEventEnablerRecordType)
                                                                                           throws OperationFailedException

Gets the superseding event enabler query inspector record corresponding to the given SupersedingEventEnabler record Type.

Parameters:

supersedingEventEnablerRecordType - a superseding event enabler record type

Returns:

the superseding event enabler query inspector record

Throws:

NullArgumentException - supersedingEventEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(supersedingEventEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.