OSID Logo
OSID Specifications
checklist package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.ChecklistSearch
Implementsosid.OsidSearch
Description

The search interface for governing checklist searches.

MethodsearchAmongChecklists
Description

Execute this search among the given list of checklists.

Parametersosid.id.IdListchecklistIdslist of checklists
ErrorsNULL_ARGUMENT checklistIds is null
CompliancemandatoryThis method must be implemented.
MethodorderChecklistResults
Description

Specify an ordering to the search results.

Parametersosid.checklist.ChecklistSearchOrderchecklistSearchOrderchecklist search order
ErrorsNULL_ARGUMENT checklistSearchOrder is null
UNSUPPORTED checklistSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetChecklistSearchRecord
Description

Gets the checklist search 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.ChecklistSearchRecordthe checklist search record
ErrorsNULL_ARGUMENT checklistSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(checklistSearchRecordType) is false
CompliancemandatoryThis method must be implemented.