OSID Specifications
calendaring rules package
Version 3.0.0
Release Candidate Preview
calendaring rules package
Version 3.0.0
Release Candidate Preview
| Interface | osid.calendaring.rules.OffsetEventEnablerQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidEnablerQueryInspector | ||
| Description |
This is the query inspector for examining offset event enabler queries. | ||
| Method | getRuledOffsetEventIdTerms | ||
| Description |
Gets the offset event | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRuledOffsetEventTerms | ||
| Description |
Gets the offset event query terms. | ||
| Return | osid.calendaring.OffsetEventQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCalendarIdTerms | ||
| Description |
Gets the calendar | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCalendarTerms | ||
| Description |
Gets the calendar query terms. | ||
| Return | osid.calendaring.CalendarQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOffsetEventEnablerQueryInspectorRecord | ||
| Description |
Gets the offset event enabler query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | offsetEventEnablerRecordType | an offset event enabler record type |
| Return | osid.calendaring.rules.records.OffsetEventEnablerQueryInspectorRecord | the offset event enabler query inspector record | |
| Errors | NULL_ARGUMENT | offsetEventEnablerRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(offsetEventEnablerRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |