OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.AwardEntryQueryInspector
Implementsosid.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 OsidQuery interfaces for reuse or modification in the search sessions.

MethodgetStudentIdTerms
Description

Gets the resource Id query terms.

Returnosid.search.terms.IdTerm[]the resource Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetStudentTerms
Description

Gets the student query terms.

Returnosid.resource.ResourceQueryInspector[]the resource query terms
CompliancemandatoryThis method must be implemented.
MethodgetAwardIdTerms
Description

Gets the award Id query terms.

Returnosid.search.terms.IdTerm[]the award Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetAwardTerms
Description

Gets the award query terms.

Returnosid.recognition.AwardQueryInspector[]the award terms
CompliancemandatoryThis method must be implemented.
MethodgetDateAwardedTerms
Description

Gets the award date query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the date terms
CompliancemandatoryThis method must be implemented.
MethodgetProgramIdTerms
Description

Gets the program Id query terms.

Returnosid.search.terms.IdTerm[]the program Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetProgramTerms
Description

Gets the program query terms.

Returnosid.course.program.ProgramQueryInspector[]the program terms
CompliancemandatoryThis method must be implemented.
MethodgetCourseIdTerms
Description

Gets the course Id query terms.

Returnosid.search.terms.IdTerm[]the course Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetCourseTerms
Description

Gets the course query terms.

Returnosid.course.CourseQueryInspector[]the course terms
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentIdTerms
Description

Gets the assessment Id query terms.

Returnosid.search.terms.IdTerm[]the assessment Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentTerms
Description

Gets the assessment query terms.

Returnosid.course.CourseQueryInspector[]the assessment terms
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogIdTerms
Description

Gets the course catalog Id query terms.

Returnosid.search.terms.IdTerm[]the course catalog Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogTerms
Description

Gets the course catalog query terms.

Returnosid.course.CourseCatalogQueryInspector[]the course catalog query terms
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntryQueryInspectorRecord
Description

Gets the award entry query inspector record corresponding to the given AwardEntry record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeawardEntryRecordTypean award entry record type
Returnosid.course.chronicle.records.AwardEntryQueryInspectorRecordthe award entry query inspector record
ErrorsNULL_ARGUMENT awardEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(awardEntryRecordType) is false
CompliancemandatoryThis method must be implemented.