OSID Logo
OSID Specifications
communication package
Version 3.0.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
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_ARGUMENTid or value is invalid
NULL_ARGUMENTid or value is null
NO_ACCESSvalue cannot be modified
CompliancemandatoryThis method must be implemented.
MethodclearValue
Description

Clears a value.

Parametersosid.id.Ididthe Id of the metadata field
ErrorsNO_ACCESSMetadata.isRequired() or Metadata.isReadOnly() is true
NULL_ARGUMENTid 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_ARGUMENTresponseRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(responseRecordType) is false
CompliancemandatoryThis method must be implemented.