org.osid.inquiry

Interface Inquiry

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidObject, OsidRule, Subjugateable

public interface Inquiry
extends OsidRule, Subjugateable

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

Method Summary

Methods

Modifier and Type	Method and Description
Audit	getAudit() Gets the audit.
Id	getAuditId() Gets the Id of the audit.
InquiryRecord	getInquiryRecord(Type inquiryRecordType) Gets the inquiry record corresponding to the given Inquiry record Type.
DisplayText	getQuestion() Gets the question.
boolean	isAffirmationRequired() Tests if a positive Response is required for this Inquiry to pass the Audit.
boolean	isRequired() Tests if a Response is required for this Inquiry.
boolean	needsOneResponse() Tests if a single effective Response is required.

Methods inherited from interface org.osid.OsidRule

getRule, getRuleId, hasRule

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Method Detail

getAuditId

Id getAuditId()

Gets the Id of the audit.

Returns:

the audit Id

Compliance:

mandatory - This method must be implemented.

getAudit

Audit getAudit()
               throws OperationFailedException

Gets the audit.

Returns:

the audit

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getQuestion

DisplayText getQuestion()

Gets the question.

Returns:

the question

Compliance:

mandatory - This method must be implemented.

isRequired

boolean isRequired()

Tests if a Response is required for this Inquiry.

Returns:

true if a response is required, false if optional

Compliance:

mandatory - This method must be implemented.

isAffirmationRequired

boolean isAffirmationRequired()

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

Returns:

true if a positive response is required, false if optional

Compliance:

mandatory - This method must be implemented.

needsOneResponse

boolean needsOneResponse()

Tests if a single effective Response is required.

Returns:

true if a single effective response is required, false responses should be collected for every inquiry

Compliance:

mandatory - This method must be implemented.

getInquiryRecord

InquiryRecord getInquiryRecord(Type inquiryRecordType)
                               throws OperationFailedException,
                                      PermissionDeniedException

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 .

Parameters:

inquiryRecordType - the type of inquiry record to retrieve

Returns:

the inquiry record

Throws:

NullArgumentException - inquiryRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(inquiryRecordType) is false

Compliance:

mandatory - This method must be implemented.