OSID Logo
OSID Specifications
checklist package
Version 3.0.0
Interfaceosid.checklist.ChecklistSearchResults
Implementsosid.OsidSearchResults
Used Byosid.checklist.ChecklistSearchSession
Description

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

MethodgetChecklists
Description

Gets the checklist list resulting from a search.

Returnosid.checklist.ChecklistListthe checklist list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetChecklistQueryInspector
Description

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

Returnosid.checklist.ChecklistQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetChecklistSearchResultsRecord
Description

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

Parametersosid.type.TypechecklistSearchRecordTypea checklist search record type
Returnosid.checklist.records.ChecklistSearchResultsRecordthe checklist search results record
ErrorsNULL_ARGUMENTChecklistSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(checklistSearchRecordType) is false
CompliancemandatoryThis method must be implemented.