public interface Inquiry extends OsidRule, Subjugateable
An Inquiry
is an OsidRule
that determines
the nature of a Response.
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. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
Id getAuditId()
Id
of the audit. Id
mandatory
- This method must be implemented. Audit getAudit() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DisplayText getQuestion()
mandatory
- This method must be implemented. boolean isRequired()
Response
is required for this
Inquiry.
true
if a response is required, false if
optionalmandatory
- This method must be implemented. boolean isAffirmationRequired()
Response
is required for this
Inquiry
to pass the Audit.
true
if a positive response is required, false
if optionalmandatory
- This method must be implemented. boolean needsOneResponse()
Response
is required. true
if a single effective response is
required, false responses should be collected for every
inquirymandatory
- This method must be implemented. InquiryRecord getInquiryRecord(Type inquiryRecordType) throws OperationFailedException, PermissionDeniedException
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
.inquiryRecordType
- the type of inquiry record to retrieveNullArgumentException
- inquiryRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(inquiryRecordType)
is false
mandatory
- This method must be implemented.