OSID Logo
OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.Inquiry
Implementsosid.OsidRule
osid.Subjugateable
Description

An Inquiry is an OsidRule that determines the nature of a Response.

MethodgetAuditId
Description

Gets the Id of the audit.

Returnosid.id.Idthe audit Id
CompliancemandatoryThis method must be implemented.
MethodgetAudit
Description

Gets the audit.

Returnosid.inquiry.Auditthe audit
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetQuestion
Description

Gets the question.

Returnosid.locale.DisplayTextthe question
CompliancemandatoryThis method must be implemented.
MethodisRequired
Description

Tests if a Response is required for this Inquiry.

Returnboolean true if a response is required, false if optional
CompliancemandatoryThis method must be implemented.
MethodisAffirmationRequired
Description

Tests if a positive Response is required for this Inquiry to pass the Audit.

Returnboolean true if a positive response is required, false if optional
CompliancemandatoryThis method must be implemented.
MethodneedsOneResponse
Description

Tests if a single effective Response is required.

Returnboolean true if a single effective response is required, false responses should be collected for every inquiry
CompliancemandatoryThis method must be implemented.
MethodgetInquiryRecord
Description

Gets the inquiry record corresponding to the given Inquiry record Type. This method is used to retrieve an object implementing the requested record. The inquiryRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(inquiryRecordType) is true .

Parametersosid.type.TypeinquiryRecordTypethe type of inquiry record to retrieve
Returnosid.inquiry.records.InquiryRecordthe inquiry record
ErrorsNULL_ARGUMENT inquiryRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(inquiryRecordType) is false
CompliancemandatoryThis method must be implemented.