OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.CredentialSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetCredentials
Description

Gets the credential list resulting from a search.

Returnosid.course.program.CredentialListthe credential list
ErrorsILLEGAL_STATEthe credential list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCredentialQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.course.program.CredentialQueryInspectorthe credential query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCredentialSearchResultsRecord
Description

Gets the credential search results record corresponding to the given credential search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypecredentialSearchRecordTypea credential search record type
Returnosid.course.program.records.CredentialSearchResultsRecordthe credential search results record
ErrorsNULL_ARGUMENT credentialSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(credentialSearchRecordType) is false
CompliancemandatoryThis method must be implemented.