OSID Logo
OSID Specifications
communication package
Version 3.0.0
Release Candidate Preview
Interfaceosid.communication.ResponseForm
Implementsosid.OsidObjectForm
Description

This is the form for submitting Responses.

MethodgetMetadata
Description

Gets the metadata for all the fields. Some fields may be required and others optional.

Returnosid.Metadata[]the metadata
CompliancemandatoryThis method must be implemented.
MethodsetValue
Description

Sets a value for a given field.

Parametersosid.id.Ididthe Id of the metadata field
objectvaluethe value
ErrorsINVALID_ARGUMENT id or value is invalid
NULL_ARGUMENT id or value is null
NO_ACCESS value cannot be modified
CompliancemandatoryThis method must be implemented.
MethodclearValue
Description

Clears a value.

Parametersosid.id.Ididthe Id of the metadata field
ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
NULL_ARGUMENT id is null
CompliancemandatoryThis method must be implemented.
MethodgetResponseFormRecord
Description

Gets the ResponseFormRecord corresponding to the given response record Type.

Parametersosid.type.TyperesponseRecordTypea response record type
Returnosid.communication.records.ResponseFormRecordthe response form record
ErrorsNULL_ARGUMENT responseRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(responseRecordType) is false
CompliancemandatoryThis method must be implemented.