OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
calendaring package
Version 3.0.0
Release Candidate Preview
| Interface | osid.calendaring.OffsetEventQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRuleQueryInspector | ||
| Description |
This is the query inspector for examining offset event queries. | ||
| Method | getFixedStartTimeTerms | ||
| Description |
Gets the fixed start time terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the fixed start time terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStartReferenceEventIdTerms | ||
| Description |
Gets the event | ||
| Return | osid.search.terms.IdTerm[] | the event Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStartReferenceEventTerms | ||
| Description |
Gets the event terms. | ||
| Return | osid.calendaring.EventQueryInspector[] | the event terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFixedStartOffsetTerms | ||
| Description |
Gets the fixed offset terms. | ||
| Return | osid.search.terms.IntegerRangeTerm[] | the fixed offset terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelativeWeekdayStartOffsetTerms | ||
| Description |
Gets the relative weekday offset terms. | ||
| Return | osid.search.terms.IntegerRangeTerm[] | the relative weekday offset terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelativeStartWeekdayTerms | ||
| Description |
Gets the relative weekday terms. | ||
| Return | osid.search.terms.CardinalTerm[] | the relative weekday terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFixedDurationTerms | ||
| Description |
Gets the fixed duration terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the fixed duration terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEndReferenceEventIdTerms | ||
| Description |
Gets the event | ||
| Return | osid.search.terms.IdTerm[] | the event Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEndReferenceEventTerms | ||
| Description |
Gets the event terms. | ||
| Return | osid.calendaring.EventQueryInspector[] | the event terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFixedEndOffsetTerms | ||
| Description |
Gets the fixed offset terms. | ||
| Return | osid.search.terms.IntegerRangeTerm[] | the fixed offset terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelativeWeekdayEndOffsetTerms | ||
| Description |
Gets the relative weekday offset terms. | ||
| Return | osid.search.terms.IntegerRangeTerm[] | the relative weekday offset terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelativeEndWeekdayTerms | ||
| Description |
Gets the relative weekday terms. | ||
| Return | osid.search.terms.CardinalTerm[] | the relative weekday terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLocationDescriptionTerms | ||
| Description |
Gets the location description terms. | ||
| Return | osid.search.terms.StringTerm[] | the location description terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLocationIdTerms | ||
| Description |
Gets the location | ||
| Return | osid.search.terms.IdTerm[] | the location Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLocationTerms | ||
| Description |
Gets the location terms. | ||
| Return | osid.mapping.LocationQueryInspector[] | the location 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 | 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 | getOffsetEventQueryInspectorRecord | ||
| Description |
Gets the offset event query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | offsetEventRecordType | an offset event query record type |
| Return | osid.calendaring.records.OffsetEventQueryInspectorRecord | the offset event query inspector record | |
| Errors | NULL_ARGUMENT | offsetEventRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(offsetEventRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |