OSID Specifications
course program package
Version 3.1.0
course program package
Version 3.1.0
| Interface | osid.course.program.ProgramOfferingQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Used By | osid.course.program.EnrollmentQueryInspector | ||
osid.course.program.ProgramOfferingQueryInspector | |||
osid.course.program.ProgramOfferingSearchResults | |||
osid.course.program.ProgramOfferingSmartCourseCatalogSession | |||
| 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 | getProgramIdTerms | ||
| Description |
Gets the course | ||
| Return | osid.search.terms.IdTerm[] | the course 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 query 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 query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTitleTerms | ||
| Description |
Gets the title query terms. | ||
| Return | osid.search.terms.StringTerm[] | the title query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getNumberTerms | ||
| Description |
Gets the bumber query terms. | ||
| Return | osid.search.terms.StringTerm[] | the number query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSponsorIdTerms | ||
| Description |
Gets the sponsor | ||
| Return | osid.search.terms.IdTerm[] | the sponsor Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSponsorTerms | ||
| Description |
Gets the sponsor query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the sponsor query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getParentProgramOfferingIdTerms | ||
| Description |
Gets the parent program offering | ||
| Return | osid.search.terms.IdTerm[] | the parent program offering Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getParentProgramOfferingTerms | ||
| Description |
Gets the parent program offering query terms. | ||
| Return | osid.course.program.ProgramOfferingQueryInspector[] | the parent program offering query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLearningObjectiveIdTerms | ||
| Description |
Gets the objective | ||
| Return | osid.search.terms.IdTerm[] | the objective Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLearningObjectiveTerms | ||
| Description |
Gets the objective query terms. | ||
| Return | osid.learning.ObjectiveQueryInspector[] | the objective query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRestrictedAudienceIdTerms | ||
| Description |
Gets the restricted audience | ||
| Return | osid.search.terms.IdTerm[] | the restricted audience Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRestrictedAudienceTerms | ||
| Description |
Gets the restricted audience query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the restricted audience query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCompletionRequirementsInfoTerms | ||
| Description |
Gets the completion requirements query terms. | ||
| Return | osid.search.terms.StringTerm[] | the prereq query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCompletionRequirementsIdTerms | ||
| Description |
Gets the completion requirements requisite
| ||
| Return | osid.search.terms.IdTerm[] | the requisite Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCompletionRequirementsTerms | ||
| Description |
Gets the completion requirements requisite query terms. | ||
| Return | osid.course.requisite.RequisiteQueryInspector[] | the requisite query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCredentialIdTerms | ||
| Description |
Gets the credential | ||
| Return | osid.search.terms.IdTerm[] | the grade system Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCredentialTerms | ||
| Description |
Gets the credential query terms. | ||
| Return | osid.course.program.CredentialQueryInspector[] | the grade system terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRequiresRegistrationTerms | ||
| Description |
Gets the requires registration query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the requires registration query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMinimumSeatsTerms | ||
| Description |
Gets the minimum seats query terms. | ||
| Return | osid.search.terms.CardinalRangeTerm[] | the minimum seats query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMaximumSeatsTerms | ||
| Description |
Gets the maximum seats query terms. | ||
| Return | osid.search.terms.CardinalRangeTerm[] | the maximum seats query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getURLTerms | ||
| Description |
Gets the url query terms. | ||
| Return | osid.search.terms.StringTerm[] | the url 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 | getProgramOfferingQueryInspectorRecord | ||
| Description |
Gets the program offering query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | programOfferingRecordType | a program offering record type |
| Return | osid.course.program.records.ProgramOfferingQueryInspectorRecord | the program offering query inspector record | |
| Errors | NULL_ARGUMENT | programOfferingRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(programOfferingRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |