OSID Logo
OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.InquiryForm
Implementsosid.OsidRuleForm
osid.OsidSubjugateableForm
Description

This is the form for creating and updating Inquiries. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the InquiryAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetQuestionMetadata
Description

Gets the metadata for the question.

Returnosid.Metadatametadata for the question
CompliancemandatoryThis method must be implemented.
MethodsetQuestion
Description

Sets the question.

Parametersstringquestionthe new question
ErrorsINVALID_ARGUMENT question is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT question is null
CompliancemandatoryThis method must be implemented.
MethodclearQuestion
Description

Removes the question.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetRequiredMetadata
Description

Gets the metadata for the required flag.

Returnosid.Metadatametadata for the required flag
CompliancemandatoryThis method must be implemented.
MethodsetRequired
Description

Sets the required flag.

Parametersbooleanrequired true is the inquiry requires a response, false if optional
ErrorsINVALID_ARGUMENT required is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearRequired
Description

Removes the required flag.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetAffirmationRequiredMetadata
Description

Gets the metadata for the affirmation required flag.

Returnosid.Metadatametadata for the required flag
CompliancemandatoryThis method must be implemented.
MethodsetAffirmationRequired
Description

Sets the affirmation required flag.

Parametersbooleanrequired true if a positive response is required, false if a negative response is also acceptable
ErrorsINVALID_ARGUMENT required is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearAffirmationRequired
Description

Removes the affirmation required flag.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetNeedsOneResponseMetadata
Description

Gets the metadata for the needs one response flag.

Returnosid.Metadatametadata for the needs one response flag
CompliancemandatoryThis method must be implemented.
MethodsetNeedsOneResponse
Description

Sets the needs one response flag.

Parametersbooleanone true if only one effective response is needed,, false if the inquiry should be performed each time
ErrorsINVALID_ARGUMENT one is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearNeedsOneResponse
Description

Removes the needs one response flag.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetInquiryFormRecord
Description

Gets the InquiryFormRecord corresponding to the given inquiry record Type.

Parametersosid.type.TypeinquiryRecordTypean inquiry record type
Returnosid.inquiry.records.InquiryFormRecordthe inquiry form record
ErrorsNULL_ARGUMENT inquiryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inquiryRecordType) is false
CompliancemandatoryThis method must be implemented.