OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
calendaring package
Version 3.0.0
Release Candidate Preview
| Interface | osid.calendaring.CalendarQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining calendar 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 | 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 | 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 | getAncestorCalendarIdTerms | ||
| Description |
Gets the ancestor calendar | ||
| Return | osid.search.terms.IdTerm[] | the ancestor calendar Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorCalendarTerms | ||
| Description |
Gets the ancestor calendar terms. | ||
| Return | osid.calendaring.CalendarQueryInspector[] | the ancestor calendar terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantCalendarIdTerms | ||
| Description |
Gets the descendant calendar | ||
| Return | osid.search.terms.IdTerm[] | the descendant calendar Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantCalendarTerms | ||
| Description |
Gets the descendant calendar terms. | ||
| Return | osid.calendaring.CalendarQueryInspector[] | the descendant calendar terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCalendarQueryInspectorRecord | ||
| Description |
Gets the calendar query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | calendarRecordType | a calendar record type |
| Return | osid.calendaring.records.CalendarQueryInspectorRecord | the calendar query inspector record | |
| Errors | NULL_ARGUMENT | calendarRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(calendarRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |