OSID Logo
OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.ResponseForm
Implementsosid.OsidRelationshipForm
Description

This is the form for creating and updating responses. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ResponseAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetAffirmativeMetadata
Description

Gets the metadata for the affirmative flag.

Returnosid.Metadatametadata for the affirmative flag
CompliancemandatoryThis method must be implemented.
MethodsetAffirmative
Description

Sets the affirmative flag.

Parametersbooleanaffirmative true is a posiitve response, false if a negative response
ErrorsINVALID_ARGUMENT affirmative is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearAffirmative
Description

Removes the affirmative flag.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetResponseFormRecord
Description

Gets the ResponseFormRecord corresponding to the given response record Type.

Parametersosid.type.TyperesponseRecordTypea response record type
Returnosid.inquiry.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.