OSID Logo
OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.InquestQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching among Inquest objects. The search query is constructed using the InquestQuery.

Inquests may have a query record indicated by their respective record types. The query record is accessed via the InquestQuery.

MethodcanSearchInquests
Description

Tests if this user can perform Inquest 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 not offer lookup operations to unauthorized users.

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

Gets an inquest query.

Returnosid.inquiry.InquestQuerythe inquest query
CompliancemandatoryThis method must be implemented.
MethodgetInquestsByQuery
Description

Gets a list of Inquests matching the given inquest query.

Parametersosid.inquiry.InquestQueryinquestQuerythe inquest query
Returnosid.inquiry.InquestListthe returned InquestList
ErrorsNULL_ARGUMENT inquestQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED inquestQuery is not of this service
CompliancemandatoryThis method must be implemented.