org.osid.communication

Interface ResponseOption

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface ResponseOption
extends OsidObject

A response option. The option may be labeled in the display name and described using the description.

Method Summary

Methods

Modifier and Type	Method and Description
ResponseOptionRecord	getResponseOptionRecord(Type responseOptionRecordType) Gets the response option record corresponding to the given ResponseOption record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getResponseOptionRecord

ResponseOptionRecord getResponseOptionRecord(Type responseOptionRecordType)
                                             throws OperationFailedException

Gets the response option record corresponding to the given ResponseOption record Type. This method is used to retrieve an object implementing the requested record. The responseOptionRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(responseOptionRecordType) is true .

Parameters:

responseOptionRecordType - the type of the record to retrieve

Returns:

the response option record

Throws:

NullArgumentException - responseOptionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(responseOptionRecordType) is false

Compliance:

mandatory - This method must be implemented.