OSID Logo
OSID Specifications
course chronicle package
Version 3.1.0
Interfaceosid.course.chronicle.CredentialEntrySearchResults
Implementsosid.OsidSearchResults
Used Byosid.course.chronicle.CredentialEntrySearchSession
Description

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

MethodgetCredentialEntries
Description

Gets the course list resulting from a search.

Returnosid.course.chronicle.CredentialEntryList the credential entry list
ErrorsILLEGAL_STATE the credential entry list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetCredentialEntryQueryInspector
Description

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

Returnosid.course.chronicle.CredentialEntryQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetCredentialEntrySearchResultsRecord
Description

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

Parametersosid.type.TypecredentialEntrySearchRecordType a credential entry search record type
Returnosid.course.chronicle.records.CredentialEntrySearchResultsRecord the credential entry search results record
ErrorsNULL_ARGUMENT credentialEntrySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(credentialEntrySearchRecordType) is false
Compliancemandatory This method must be implemented.