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.CyclicTimePeriodQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
| Description |
This is the query inspector for examining cyclic time period queries. | ||
| Method | getTimePeriodIdTerms | ||
| Description |
Gets the time period | ||
| Return | osid.search.terms.IdTerm[] | the time period Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTimePeriodTerms | ||
| Description |
Gets the time period terms. | ||
| Return | osid.calendaring.TimePeriodQueryInspector[] | the time period 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 | getCyclicTimePeriodQueryInspectorRecord | ||
| Description |
Gets the cyclic time period query record interface
corresponding to the given | ||
| Parameters | osid.type.Type | cyclicTimePeriodRecordType | a cyclic time period query record type |
| Return | osid.calendaring.cycle.records.CyclicTimePeriodQueryInspectorRecord | the cyclic time period query inspector record | |
| Errors | NULL_ARGUMENT | cyclicTimePeriodRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(cyclicTimePeriodRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |