OSID Logo
OSID Specifications
communication package
Version 3.1.0
Interfaceosid.communication.ResponseForm
Implementsosid.OsidObjectForm
Used Byosid.communication.CommunicationSession
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
Compliancemandatory This method must be implemented.
MethodsetValue
Description

Sets a value for a given field.

Parametersosid.id.Idid the Id of the metadata field
objectvalue the value
ErrorsINVALID_ARGUMENT id or value is invalid
NULL_ARGUMENT id or value is null
NO_ACCESS value cannot be modified
Compliancemandatory This method must be implemented.
MethodclearValue
Description

Clears a value.

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

Gets the ResponseFormRecord corresponding to the given response record Type.

Parametersosid.type.TyperesponseRecordType a response record type
Returnosid.communication.records.ResponseFormRecord the response form record
ErrorsNULL_ARGUMENT responseRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(responseRecordType) is false
Compliancemandatory This method must be implemented.