OSID Specifications
calendaring cycle package
Version 3.0.0
Release Candidate Preview
calendaring cycle package
Version 3.0.0
Release Candidate Preview
| Interface | osid.calendaring.cycle.CyclicEventQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
| Description |
This is the query inspector for examining event queries. | ||
| 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 | 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 | getCyclicEventQueryInspectorRecord | ||
| Description |
Gets the cyclic event query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | cyclicEventRecordType | a cyclic event query record type |
| Return | osid.calendaring.cycle.records.CyclicEventQueryInspectorRecord | the cyclic event query inspector record | |
| Errors | NULL_ARGUMENT | cyclicEventRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(cyclicEventRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |