OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.CredentialEntryQueryInspector
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.
MethodgetCredentialIdTerms
Description

Gets the credential Id query terms.

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

Gets the credential query terms.

Returnosid.course.program.CredentialQueryInspector[]the credential 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.
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.
MethodgetCredentialEntryQueryInspectorRecord
Description

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

Parametersosid.type.TypecredentialEntryRecordTypea credential entry record type
Returnosid.course.chronicle.records.CredentialEntryQueryInspectorRecordthe credential entry query inspector record
ErrorsNULL_ARGUMENT credentialEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(credentialEntryRecordType) is false
CompliancemandatoryThis method must be implemented.