OSID Logo
OSID Specifications
course program package
Version 3.1.0
Interfaceosid.course.program.CredentialSearchResults
Implementsosid.OsidSearchResults
Used Byosid.course.program.CredentialSearchSession
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.CredentialList the credential list
ErrorsILLEGAL_STATE the credential list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetCredentialQueryInspector
Description

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

Returnosid.course.program.CredentialQueryInspector the credential query inspector
Compliancemandatory This 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.TypecredentialSearchRecordType a credential search record type
Returnosid.course.program.records.CredentialSearchResultsRecord the credential search results record
ErrorsNULL_ARGUMENT credentialSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(credentialSearchRecordType) is false
Compliancemandatory This method must be implemented.