| Interface | osid.communication.ResponseForm | ||
|---|---|---|---|
| Implements | osid.OsidObjectForm | ||
| Description | 
                 This is the form for submitting   | ||
| Method | getMetadata | ||
| Description | 
                     Gets the metadata for all the fields. Some fields may be required and others optional.  | ||
| Return | osid.Metadata[] | the metadata | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setValue | ||
| Description | 
                     Sets a value for a given field.  | ||
| Parameters | osid.id.Id | id | the  Id  of the metadata field  | 
object | value | the value | |
| Errors | INVALID_ARGUMENT |  id  or  value  is invalid  |                 |
| NULL_ARGUMENT |  id  or  value  is  null   |                 ||
| NO_ACCESS |  value  cannot be modified  |                 ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearValue | ||
| Description | 
                     Clears a value.  | ||
| Parameters | osid.id.Id | id | the  Id  of the metadata field  | 
| Errors | NO_ACCESS |  Metadata.isRequired()  or  Metadata.isReadOnly() 
 is  true   |                 |
| NULL_ARGUMENT |  id  is  null   |                 ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getResponseFormRecord | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.type.Type | responseRecordType | a response record type | 
| Return | osid.communication.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. | |