OSID Logo
OSID Specifications
checklist package
Version 3.1.0
Interfaceosid.checklist.ChecklistSearch
Implementsosid.OsidSearch
Used Byosid.checklist.ChecklistSearchSession
Description

The search interface for governing checklist searches.

MethodsearchAmongChecklists
Description

Execute this search among the given list of checklists.

Parametersosid.id.IdListchecklistIds list of checklists
ErrorsNULL_ARGUMENT checklistIds is null
Compliancemandatory This method must be implemented.
MethodorderChecklistResults
Description

Specify an ordering to the search results.

Parametersosid.checklist.ChecklistSearchOrderchecklistSearchOrder checklist search order
ErrorsNULL_ARGUMENT checklistSearchOrder is null
UNSUPPORTED checklistSearchOrder is not of this service
Compliancemandatory This 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.TypechecklistSearchRecordType a checklist search record type
Returnosid.checklist.records.ChecklistSearchRecord the checklist search record
ErrorsNULL_ARGUMENT checklistSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(checklistSearchRecordType) is false
Compliancemandatory This method must be implemented.