org.osid.calendaring

Interface RecurringEventQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidContainableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector

public interface RecurringEventQueryInspector
extends OsidRuleQueryInspector, OsidContainableQueryInspector

This is the query inspector for examining recurring event queries.

Method Summary

Methods

Modifier and Type	Method and Description
DateTimeRangeTerm[]	getBlackoutInclusiveTerms() Gets the inclusive blackout terms.
DateTimeTerm[]	getBlackoutTerms() Gets the blackout terms.
IdTerm[]	getCalendarIdTerms() Gets the calendar Id terms.
CalendarQueryInspector[]	getCalendarTerms() Gets the calendar terms.
IdTerm[]	getEventIdTerms() Gets the event Id terms.
EventQueryInspector[]	getEventTerms() Gets the event terms.
RecurringEventQueryInspectorRecord	getRecurringEventQueryInspectorRecord(Type recurringEventRecordType) Gets the recurring event query inspector record corresponding to the given RecurringEvent record Type.
IdTerm[]	getScheduleIdTerms() Gets the schedule Id terms.
ScheduleQueryInspector[]	getScheduleTerms() Gets the schedule terms.
DateTimeTerm[]	getSpecificMeetingTimeTerms() Gets the date terms.
IdTerm[]	getSponsorIdTerms() Gets the sponsor Id terms.
ResourceQueryInspector[]	getSponsorTerms() Gets the sponsor terms.
IdTerm[]	getSupersedingEventIdTerms() Gets the superseding event Id terms.
SupersedingEventQueryInspector[]	getSupersedingEventTerms() Gets the superseding event terms.

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.OsidContainableQueryInspector

getSequesteredTerms

Method Detail

getScheduleIdTerms

IdTerm[] getScheduleIdTerms()

Gets the schedule Id terms.

Returns:

the schedule Id terms

Compliance:

mandatory - This method must be implemented.

getScheduleTerms

ScheduleQueryInspector[] getScheduleTerms()

Gets the schedule terms.

Returns:

the schedule terms

Compliance:

mandatory - This method must be implemented.

getSupersedingEventIdTerms

IdTerm[] getSupersedingEventIdTerms()

Gets the superseding event Id terms.

Returns:

the superseding event Id terms

Compliance:

mandatory - This method must be implemented.

getSupersedingEventTerms

SupersedingEventQueryInspector[] getSupersedingEventTerms()

Gets the superseding event terms.

Returns:

the superseding event terms

Compliance:

mandatory - This method must be implemented.

getEventIdTerms

IdTerm[] getEventIdTerms()

Gets the event Id terms.

Returns:

the event Id terms

Compliance:

mandatory - This method must be implemented.

getEventTerms

EventQueryInspector[] getEventTerms()

Gets the event terms.

Returns:

the event terms

Compliance:

mandatory - This method must be implemented.

getBlackoutTerms

DateTimeTerm[] getBlackoutTerms()

Gets the blackout terms.

Returns:

the time terms

Compliance:

mandatory - This method must be implemented.

getBlackoutInclusiveTerms

DateTimeRangeTerm[] getBlackoutInclusiveTerms()

Gets the inclusive blackout terms.

Returns:

the time range terms

Compliance:

mandatory - This method must be implemented.

getSponsorIdTerms

IdTerm[] getSponsorIdTerms()

Gets the sponsor Id terms.

Returns:

the sponsor Id terms

Compliance:

mandatory - This method must be implemented.

getSponsorTerms

ResourceQueryInspector[] getSponsorTerms()

Gets the sponsor terms.

Returns:

the sponsor terms

Compliance:

mandatory - This method must be implemented.

getSpecificMeetingTimeTerms

DateTimeTerm[] getSpecificMeetingTimeTerms()

Gets the date terms.

Returns:

the time terms

Compliance:

mandatory - This method must be implemented.

getCalendarIdTerms

IdTerm[] getCalendarIdTerms()

Gets the calendar Id terms.

Returns:

the calendar Id terms

Compliance:

mandatory - This method must be implemented.

getCalendarTerms

CalendarQueryInspector[] getCalendarTerms()

Gets the calendar terms.

Returns:

the calendar terms

Compliance:

mandatory - This method must be implemented.

getRecurringEventQueryInspectorRecord

RecurringEventQueryInspectorRecord getRecurringEventQueryInspectorRecord(Type recurringEventRecordType)
                                                                         throws OperationFailedException

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

Parameters:

recurringEventRecordType - a recurring event query record type

Returns:

the recurring event query inspector record

Throws:

NullArgumentException - recurringEventRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(recurringEventRecordType) is false

Compliance:

mandatory - This method must be implemented.