OSID Logo
OSID Specifications
checklist package
Version 3.1.0
Interfaceosid.checklist.ChecklistQuerySession
Implementsosid.OsidSession
Implemented Byosid.checklist.ChecklistSearchSession
Used Byosid.checklist.ChecklistManager
osid.checklist.ChecklistProxyManager
Description

This session provides methods for searching Checklists. 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
Compliancemandatory This method must be implemented.
MethodgetChecklistQuery
Description

Gets a checklist query.

Returnosid.checklist.ChecklistQuery the checklist query
Compliancemandatory This method must be implemented.
MethodgetChecklistsByQuery
Description

Gets a list of Checklists matching the given search.

Parametersosid.checklist.ChecklistQuerychecklistQuery the checklist query
Returnosid.checklist.ChecklistList the returned ChecklistList
ErrorsNULL_ARGUMENT checklistQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED checklistQuery is not of this service
Compliancemandatory This method must be implemented.