OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
calendaring package
Version 3.0.0
Release Candidate Preview
| Interface | osid.calendaring.EventQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidTemporalQueryInspector | |||
osid.OsidContainableQueryInspector | |||
| Description |
This is the query inspector for examining event queries. | ||
| Method | getImplicitTerms | ||
| Description |
Gets the implicit terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the implicit terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDurationTerms | ||
| Description |
Gets the duration terms. | ||
| Return | osid.search.terms.DurationTerm[] | the duration terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRecurringEventIdTerms | ||
| Description |
Gets the recurring event | ||
| Return | osid.search.terms.IdTerm[] | the recurring event Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRecurringEventTerms | ||
| Description |
Gets the recurring event terms. | ||
| Return | osid.calendaring.RecurringEventQueryInspector[] | the recurring event 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 | getOffsetEventIdTerms | ||
| Description |
Gets the offset event | ||
| Return | osid.search.terms.IdTerm[] | the offset event Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOffsetEventTerms | ||
| Description |
Gets the offset event terms. | ||
| Return | osid.calendaring.OffsetEventQueryInspector[] | the offset event 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 | getCoordinateTerms | ||
| Description |
Gets the coordinate terms. | ||
| Return | osid.search.terms.CoordinateTerm[] | the coordinate terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSpatialUnitTerms | ||
| Description |
Gets the spatial unit terms. | ||
| Return | osid.search.terms.SpatialUnitTerm[] | the spatial unit terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommitmentIdTerms | ||
| Description |
Gets the commitment | ||
| Return | osid.search.terms.IdTerm[] | the commitment Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommitmentTerms | ||
| Description |
Gets the commitment terms. | ||
| Return | osid.calendaring.CommitmentQueryInspector[] | the commitment terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContainingEventIdTerms | ||
| Description |
Gets the containing event | ||
| Return | osid.search.terms.IdTerm[] | the event Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContainingEventTerms | ||
| Description |
Gets the containing 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 | getEventQueryInspectorRecord | ||
| Description |
Gets the event query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | eventRecordType | an event query record type |
| Return | osid.calendaring.records.EventQueryInspectorRecord | the event query inspector record | |
| Errors | NULL_ARGUMENT | eventRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(eventRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |