OSID Specifications
course program package
Version 3.1.0
course program package
Version 3.1.0
| Interface | osid.course.program.ProgramQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidOperableQueryInspector | |||
| Used By | osid.course.chronicle.AssessmentEntryQueryInspector | ||
osid.course.chronicle.AwardEntryQueryInspector | |||
osid.course.chronicle.CredentialEntryQueryInspector | |||
osid.course.chronicle.ProgramEntryQueryInspector | |||
osid.course.program.CredentialQueryInspector | |||
osid.course.program.ProgramOfferingQueryInspector | |||
osid.course.program.ProgramQueryInspector | |||
osid.course.program.ProgramSearchResults | |||
osid.course.program.ProgramSmartCourseCatalogSession | |||
osid.course.requisite.RequisiteQueryInspector | |||
| 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 | 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 | getParentProgramIdTerms | ||
| Description |
Gets the parent program | ||
| Return | osid.search.terms.IdTerm[] | the program Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getParentProgramTerms | ||
| Description |
Gets the parent program query terms. | ||
| Return | osid.course.program.ProgramQueryInspector[] | the obective query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLearningObjectiveIdTerms | ||
| Description |
Gets the learning obective | ||
| Return | osid.search.terms.IdTerm[] | the objective Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLearningObjectiveTerms | ||
| Description |
Gets the learning obective query terms. | ||
| Return | osid.learning.ObjectiveQueryInspector[] | the obective query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTargetAudienceIdTerms | ||
| Description |
Gets the target audience | ||
| Return | osid.search.terms.IdTerm[] | the target audience Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTargetAudienceTerms | ||
| Description |
Gets the target audience query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the target 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 | 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 | getProgramQueryInspectorRecord | ||
| Description |
Gets the program query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | programRecordType | a program record type |
| Return | osid.course.program.records.ProgramQueryInspectorRecord | the program query inspector record | |
| Errors | NULL_ARGUMENT | programRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(programRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |