OSID Specifications
calendaring package
Version 3.1.0
calendaring package
Version 3.1.0
| Interface | osid.calendaring.CommitmentQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Used By | osid.calendaring.CalendarQueryInspector | ||
osid.calendaring.CommitmentSearchResults | |||
osid.calendaring.CommitmentSmartCalendarSession | |||
osid.calendaring.EventQueryInspector | |||
osid.calendaring.rules.CommitmentEnablerQueryInspector | |||
| Description |
This is the query inspector for examining commitment 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 | getResourceIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the resource Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceTerms | ||
| Description |
Gets the resource terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the resource 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 | getCommitmentQueryInspectorRecord | ||
| Description |
Gets the commitment query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | commitmentRecordType | a commitment query record type |
| Return | osid.calendaring.records.CommitmentQueryInspectorRecord | the commitment query inspector record | |
| Errors | NULL_ARGUMENT | commitmentRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(commitmentRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |