Interface | osid.inquiry.ResponseForm | ||
---|---|---|---|
Implements | osid.OsidRelationshipForm | ||
Description |
This is the form for creating and updating responses.
| ||
Method | getAffirmativeMetadata | ||
Description |
Gets the metadata for the affirmative flag. | ||
Return | osid.Metadata | metadata for the affirmative flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setAffirmative | ||
Description |
Sets the affirmative flag. | ||
Parameters | boolean | affirmative | true is a posiitve response, false if a
negative response |
Errors | INVALID_ARGUMENT | affirmative is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearAffirmative | ||
Description |
Removes the affirmative flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getResponseFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | responseRecordType | a response record type |
Return | osid.inquiry.records.ResponseFormRecord | the response form record | |
Errors | NULL_ARGUMENT | responseRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(responseRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |