OSID Logo
OSID Specifications
checklist package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.ChecklistQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching Checklist objects. The search query is constructed using the ChecklistQuery. The checklist record Type also specifies the record for the checklist query.

Checklists may have a query record indicated by their respective record types. The query record is accessed via the ChecklistQuery. The returns in this session may not be cast directly to these interfaces.

MethodcanSearchChecklists
Description

Tests if this user can perform Checklist searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetChecklistQuery
Description

Gets a checklist query.

Returnosid.checklist.ChecklistQuerythe checklist query
CompliancemandatoryThis method must be implemented.
MethodgetChecklistsByQuery
Description

Gets a list of Checklists matching the given search.

Parametersosid.checklist.ChecklistQuerychecklistQuerythe checklist query
Returnosid.checklist.ChecklistListthe returned ChecklistList
ErrorsNULL_ARGUMENT checklistQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED checklistQuery is not of this service
CompliancemandatoryThis method must be implemented.