OSID - osid.inquiry.InquiryForm Service Interface Definition

Interface	osid.inquiry.InquiryForm
Implements	`osid.OsidRuleForm`
Implements	`osid.OsidSubjugateableForm`
Implemented By	`osid.inquiry.batch.InquiryBatchForm`
Implemented By	`osid.inquiry.batch.AuditBatchForm`
Used By	`osid.inquiry.InquiryAdminSession`
Description	This is the form for creating and updating `Inquiries`. Like all `OsidForms`, 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.
Method	getAuditorsMetadata
Description	Gets the metadata for the auditors.
Return	`osid.Metadata`		metadata for the auditors
Compliance	`mandatory`		This method must be implemented.
Method	setAuditors
Description	Sets the auditors.
Parameters	`osid.id.IdList`	`auditorIds`	the new auditors
Errors	INVALID_ARGUMENT		`auditorIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`auditorIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAuditors
Description	Removes the auditors.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getQuestionMetadata
Description	Gets the metadata for the question.
Return	`osid.Metadata`		metadata for the question
Compliance	`mandatory`		This method must be implemented.
Method	setQuestion
Description	Sets the question.
Parameters	`string`	`question`	the new question
Errors	INVALID_ARGUMENT		`question` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`question` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearQuestion
Description	Removes the question.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRequiredMetadata
Description	Gets the metadata for the required flag.
Return	`osid.Metadata`		metadata for the required flag
Compliance	`mandatory`		This method must be implemented.
Method	setRequired
Description	Sets the required flag.
Parameters	`boolean`	`required`	`true` is the inquiry requires a response, `false` if optional
Errors	INVALID_ARGUMENT		`required` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequired
Description	Removes the required flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAffirmationRequiredMetadata
Description	Gets the metadata for the affirmation required flag.
Return	`osid.Metadata`		metadata for the required flag
Compliance	`mandatory`		This method must be implemented.
Method	setAffirmationRequired
Description	Sets the affirmation required flag.
Parameters	`boolean`	`required`	`true` if a positive response is required, `false` if a negative response is also acceptable
Errors	INVALID_ARGUMENT		`required` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearAffirmationRequired
Description	Removes the affirmation required flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getNeedsOneResponseMetadata
Description	Gets the metadata for the needs one response flag.
Return	`osid.Metadata`		metadata for the needs one response flag
Compliance	`mandatory`		This method must be implemented.
Method	setNeedsOneResponse
Description	Sets the needs one response flag.
Parameters	`boolean`	`one`	`true` if only one effective response is needed,, `false` if the inquiry should be performed each time
Errors	INVALID_ARGUMENT		`one` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearNeedsOneResponse
Description	Removes the needs one response flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryFormRecord
Description	Gets the `InquiryFormRecord` corresponding to the given inquiry record `Type`.
Parameters	`osid.type.Type`	`inquiryRecordType`	an inquiry record type
Return	`osid.inquiry.records.InquiryFormRecord`		the inquiry form record
Errors	NULL_ARGUMENT		`inquiryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(inquiryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.