OSID Specifications
course chronicle package
Version 3.1.0
course chronicle package
Version 3.1.0
| Interface | osid.course.chronicle.AwardEntryQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Used By | osid.course.chronicle.AwardEntrySearchResults | ||
osid.course.chronicle.AwardEntrySmartCourseCatalogSession | |||
| Description |
The query inspectors provide a means of accessing the
match terms of a query. These interfaces are used to examine
the actual query terms used in a search or that may be used to
create a smart catalog. Query inspectors may be converted to
| ||
| Method | getStudentIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the resource Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStudentTerms | ||
| Description |
Gets the student query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the resource query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAwardIdTerms | ||
| Description |
Gets the award | ||
| Return | osid.search.terms.IdTerm[] | the award Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAwardTerms | ||
| Description |
Gets the award query terms. | ||
| Return | osid.recognition.AwardQueryInspector[] | the award terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDateAwardedTerms | ||
| Description |
Gets the award date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the date terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProgramIdTerms | ||
| Description |
Gets the program | ||
| Return | osid.search.terms.IdTerm[] | the program Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProgramTerms | ||
| Description |
Gets the program query terms. | ||
| Return | osid.course.program.ProgramQueryInspector[] | the program terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseIdTerms | ||
| Description |
Gets the course | ||
| Return | osid.search.terms.IdTerm[] | the course Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseTerms | ||
| Description |
Gets the course query terms. | ||
| Return | osid.course.CourseQueryInspector[] | the course terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssessmentIdTerms | ||
| Description |
Gets the assessment | ||
| Return | osid.search.terms.IdTerm[] | the assessment Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssessmentTerms | ||
| Description |
Gets the assessment query terms. | ||
| Return | osid.course.CourseQueryInspector[] | the assessment terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseCatalogIdTerms | ||
| Description |
Gets the course catalog | ||
| Return | osid.search.terms.IdTerm[] | the course catalog Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseCatalogTerms | ||
| Description |
Gets the course catalog query terms. | ||
| Return | osid.course.CourseCatalogQueryInspector[] | the course catalog query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAwardEntryQueryInspectorRecord | ||
| Description |
Gets the award entry query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | awardEntryRecordType | an award entry record type |
| Return | osid.course.chronicle.records.AwardEntryQueryInspectorRecord | the award entry query inspector record | |
| Errors | NULL_ARGUMENT | awardEntryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(awardEntryRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |