OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
calendaring package
Version 3.0.0
Release Candidate Preview
| Interface | osid.calendaring.RecurringEventQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRuleQueryInspector | ||
osid.OsidContainableQueryInspector | |||
| Description |
This is the query inspector for examining recurring event queries. | ||
| Method | getScheduleIdTerms | ||
| Description |
Gets the schedule | ||
| Return | osid.search.terms.IdTerm[] | the schedule Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getScheduleTerms | ||
| Description |
Gets the schedule terms. | ||
| Return | osid.calendaring.ScheduleQueryInspector[] | the schedule terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSupersedingEventIdTerms | ||
| Description |
Gets the superseding event | ||
| Return | osid.search.terms.IdTerm[] | the superseding event Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSupersedingEventTerms | ||
| Description |
Gets the superseding event terms. | ||
| Return | osid.calendaring.SupersedingEventQueryInspector[] | the superseding event terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEventIdTerms | ||
| Description |
Gets the event | ||
| Return | osid.search.terms.IdTerm[] | the event Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEventTerms | ||
| Description |
Gets the event terms. | ||
| Return | osid.calendaring.EventQueryInspector[] | the event terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBlackoutTerms | ||
| Description |
Gets the blackout terms. | ||
| Return | osid.search.terms.DateTimeTerm[] | the time terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBlackoutInclusiveTerms | ||
| Description |
Gets the inclusive blackout terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the time range terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSponsorIdTerms | ||
| Description |
Gets the sponsor | ||
| Return | osid.search.terms.IdTerm[] | the sponsor Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSponsorTerms | ||
| Description |
Gets the sponsor terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the sponsor terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSpecificMeetingTimeTerms | ||
| Description |
Gets the date terms. | ||
| Return | osid.search.terms.DateTimeTerm[] | the time terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCalendarIdTerms | ||
| Description |
Gets the calendar | ||
| Return | osid.search.terms.IdTerm[] | the calendar Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCalendarTerms | ||
| Description |
Gets the calendar terms. | ||
| Return | osid.calendaring.CalendarQueryInspector[] | the calendar terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRecurringEventQueryInspectorRecord | ||
| Description |
Gets the recurring event query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | recurringEventRecordType | a recurring event query record type |
| Return | osid.calendaring.records.RecurringEventQueryInspectorRecord | the recurring event query inspector record | |
| Errors | NULL_ARGUMENT | recurringEventRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(recurringEventRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |