OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.CredentialEntrySearchResults
Implementsosid.OsidSearchResults
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.CredentialEntryListthe credential entry list
ErrorsILLEGAL_STATEthe credential entry list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCredentialEntryQueryInspector
Description

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

Returnosid.course.chronicle.CredentialEntryQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypecredentialEntrySearchRecordTypea credential entry search record type
Returnosid.course.chronicle.records.CredentialEntrySearchResultsRecordthe credential entry search results record
ErrorsNULL_ARGUMENT credentialEntrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(credentialEntrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.