OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.CredentialQueryInspector
Implementsosid.OsidObjectQueryInspector
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.

MethodgetLifetimeTerms
Description

Gets the lifetime query terms.

Returnosid.search.terms.DurationRangeTerm[]the query 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 query 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.
MethodgetCredentialQueryInspectorRecord
Description

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

Parametersosid.type.TypecredentialRecordTypea credential record type
Returnosid.course.program.records.CredentialQueryInspectorRecordthe credential query inspector record
ErrorsNULL_ARGUMENT credentialRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(credentialRecordType) is false
CompliancemandatoryThis method must be implemented.