OSID Logo
OSID Specifications
inquiry package
Version 3.1.0
Interfaceosid.inquiry.Inquiry
Implementsosid.OsidRule
osid.Subjugateable
Used Byosid.inquiry.InquiryAdminSession
osid.inquiry.InquiryList
osid.inquiry.InquiryLookupSession
osid.inquiry.Response
Description

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

MethodgetAuditorIds
Description

Gets the Ids of the auditors.

Returnosid.id.IdList the auditor Ids
Compliancemandatory This method must be implemented.
MethodgetAuditors
Description

Gets the auditors.

Returnosid.resource.ResourceList the auditors
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAuditId
Description

Gets the Id of the audit.

Returnosid.id.Id the audit Id
Compliancemandatory This method must be implemented.
MethodgetAudit
Description

Gets the audit.

Returnosid.inquiry.Audit the audit
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetQuestion
Description

Gets the question.

Returnosid.locale.DisplayText the question
Compliancemandatory This 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
Compliancemandatory This 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
Compliancemandatory This 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
Compliancemandatory This 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.TypeinquiryRecordType the type of inquiry record to retrieve
Returnosid.inquiry.records.InquiryRecord the inquiry record
ErrorsNULL_ARGUMENT inquiryRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(inquiryRecordType) is false
Compliancemandatory This method must be implemented.