OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
course chronicle package
Version 3.0.0
Release Candidate Preview
| Interface | osid.course.chronicle.ProgramEntryQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| 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 | 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 | getAdmissionDateTerms | ||
| Description |
Gets the admission date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the date terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCompleteTerms | ||
| Description |
Gets the compledt program query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the completed course terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTermIdTerms | ||
| Description |
Gets the term | ||
| Return | osid.search.terms.IdTerm[] | the term Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTermTerms | ||
| Description |
Gets the term query terms. | ||
| Return | osid.course.TermQueryInspector[] | the term terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCreditScaleIdTerms | ||
| Description |
Gets the grade system | ||
| Return | osid.search.terms.IdTerm[] | the grade system Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCreditScaleTerms | ||
| Description |
Gets the grade system query terms. | ||
| Return | osid.grading.GradeSystemQueryInspector[] | the grade system terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCreditsEarnedTerms | ||
| Description |
Gets the earned credits query terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the earned credits query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGPAScaleIdTerms | ||
| Description |
Gets the grade system | ||
| Return | osid.search.terms.IdTerm[] | the grade system Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGPAScaleTerms | ||
| Description |
Gets the grade system query terms. | ||
| Return | osid.grading.GradeSystemQueryInspector[] | the grade system terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGPATerms | ||
| Description |
Gets the GPA query terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the GPA query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEnrollmentIdTerms | ||
| Description |
Gets the enrollment | ||
| Return | osid.search.terms.IdTerm[] | the enrollment Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEnrollmentTerms | ||
| Description |
Gets the enrollment query terms. | ||
| Return | osid.course.program.EnrollmentQueryInspector[] | the enrollment query 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 | getProgramEntryQueryInspectorRecord | ||
| Description |
Gets the program entry query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | programEntryRecordType | a program entry record type |
| Return | osid.course.chronicle.records.ProgramEntryQueryInspectorRecord | the program entry query inspector record | |
| Errors | NULL_ARGUMENT | programEntryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(programEntryRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |