org.qtitools.qti.node.item.interaction
Class HottextInteraction

java.lang.Object
  org.qtitools.qti.node.AbstractNode
      org.qtitools.qti.node.AbstractObject
          org.qtitools.qti.node.content.BodyElement
              org.qtitools.qti.node.item.interaction.Interaction
                  org.qtitools.qti.node.item.interaction.BlockInteraction
                      org.qtitools.qti.node.item.interaction.HottextInteraction

All Implemented Interfaces:

java.io.Serializable, Block, Flow, ObjectFlow, XmlNode, XmlObject, Validatable

public class HottextInteraction
extends BlockInteraction

The hottext interaction presents a set of choices to the candidate represented as selectable runs of text embedded within a surrounding context, such as a simple passage of text. Like choiceInteraction, the candidate's task is to select one or more of the choices, up to a maximum of maxChoices. The interaction is initialized from the defaultValue of the associated response variable, a NULL value indicating that no choices are selected (the usual case). The hottextInteraction must be bound to a response variable with a baseType of identifier and single or multiple cardinality. Attribute : maxChoices [1]: integer = 1 The maximum number of choices that can be selected by the candidate. If matchChoices is 0 there is no restriction. If maxChoices is greater than 1 (or 0) then the interaction must be bound to a response with multiple cardinality. Attribute : minChoices [0..1]: integer = 0 The minimum number of choices that the candidate is required to select to form a valid response. If minChoices is 0 then the candidate is not required to select any choices. minChoices must be less than or equal to the limit imposed by maxChoices. Contains : blockStatic [1..*] The content of the interaction is simply a piece of content, such as a simple passage of text, that contains the hottext areas.

Author:

Jonathon Hare

See Also:

Serialized Form

Field Summary

static int	ATTR_MAX_CHOICES_DEFAULT_VALUE Default value of maxChoices attribute .
static java.lang.String	ATTR_MAX_CHOICES_NAME Name of maxChoices attribute in xml schema.
static int	ATTR_MIN_CHOICES_DEFAULT_VALUE Default value of minChoices attribute .
static java.lang.String	ATTR_MIN_CHOICES_NAME Name of minChoices attribute in xml schema.
static java.lang.String	CLASS_TAG Name of this class in xml schema.

Fields inherited from class org.qtitools.qti.node.item.interaction.Interaction

ATTR_RESPONSE_IDENTIFIER_NAME, CLASS_TAG_SUFFIX, DISPLAY_NAME

Fields inherited from class org.qtitools.qti.node.content.BodyElement

ATTR_CLASS_NAME, ATTR_ID_NAME, ATTR_LABEL_NAME, ATTR_LANG_NAME

Fields inherited from interface org.qtitools.qti.node.content.basic.Block

DISPLAY_NAME

Fields inherited from interface org.qtitools.qti.node.content.basic.Flow

DISPLAY_NAME

Constructor Summary

HottextInteraction(XmlObject parent)
Construct new interaction.

Method Summary

java.util.List<BlockStatic>	getBlockStatics() Gets blockStatic children.
java.util.List<? extends XmlNode>	getChildren() Gets an unmodifiable list of the child elements.
java.lang.String	getClassTag() Gets QTI class name of this node.
java.lang.Integer	getMaxChoices() Gets value of maxChoices attribute.
java.lang.Integer	getMinChoices() Gets value of minChoices attribute.
void	setMaxChoices(java.lang.Integer maxChoices) Sets new value of maxChoices attribute.
void	setMinChoices(java.lang.Integer minChoices) Sets new value of minChoices attribute.
ValidationResult	validate() Validates this object.
boolean	validateResponse() Validate the response associated with this interaction Subclasses should override this method as required.

Methods inherited from class org.qtitools.qti.node.item.interaction.BlockInteraction

getPrompt, setPrompt

Methods inherited from class org.qtitools.qti.node.item.interaction.Interaction

beforeProcessResponse, getResponseDeclaration, getResponseIdentifier, getShuffledOrder, initialize, processResponse, processResponse, processResponse, setResponseIdentifier

Methods inherited from class org.qtitools.qti.node.content.BodyElement

appendChild, evaluate, getClassAttr, getFirstChild, getId, getLabel, getLang, getLastChild, insertBefore, removeChild, replaceChild, search, search, search, setId, setLabel, setLang

Methods inherited from class org.qtitools.qti.node.AbstractObject

getParent, getParentItem, getParentResult, getParentTest, setParent

Methods inherited from class org.qtitools.qti.node.AbstractNode

attrToXmlString, bodyToXmlString, getAttributes, getFullName, getIndent, getNode, getNode, getNode, getNodeGroups, getParentRoot, getSimpleName, getSourceFile, getSourceNode, getSourceString, getSourceUrl, hasChildNodes, load, load, load, load, loadAttributes, readChild, readChildren, setParent, setSourceFile, setSourceNode, setSourceString, setSourceUrl, toXmlString, toXmlString, validateAttributes, validateChildren

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_TAG

public static java.lang.String CLASS_TAG

Name of this class in xml schema.

ATTR_MAX_CHOICES_NAME

public static java.lang.String ATTR_MAX_CHOICES_NAME

Name of maxChoices attribute in xml schema.

ATTR_MAX_CHOICES_DEFAULT_VALUE

public static int ATTR_MAX_CHOICES_DEFAULT_VALUE

Default value of maxChoices attribute .

ATTR_MIN_CHOICES_NAME

public static java.lang.String ATTR_MIN_CHOICES_NAME

Name of minChoices attribute in xml schema.

ATTR_MIN_CHOICES_DEFAULT_VALUE

public static int ATTR_MIN_CHOICES_DEFAULT_VALUE

Default value of minChoices attribute .

Constructor Detail

HottextInteraction

public HottextInteraction(XmlObject parent)

Construct new interaction.

Parameters:

parent - Parent node

Method Detail

setMaxChoices

public void setMaxChoices(java.lang.Integer maxChoices)

Sets new value of maxChoices attribute.

Parameters:

maxChoices - new value of maxChoices attribute

See Also:

getMaxChoices()

getMaxChoices

public java.lang.Integer getMaxChoices()

Gets value of maxChoices attribute.

Returns:

value of maxChoices attribute

See Also:

setMaxChoices(java.lang.Integer)

setMinChoices

public void setMinChoices(java.lang.Integer minChoices)

Sets new value of minChoices attribute.

Parameters:

minChoices - new value of minChoices attribute

See Also:

getMinChoices()

getMinChoices

public java.lang.Integer getMinChoices()

Gets value of minChoices attribute.

Returns:

value of minChoices attribute

See Also:

setMinChoices(java.lang.Integer)

validateResponse

public boolean validateResponse()

Description copied from class: Interaction

Validate the response associated with this interaction Subclasses should override this method as required.

Overrides:

validateResponse in class Interaction

Returns:

true if the response is valid, false otherwise

validate

public ValidationResult validate()

Description copied from interface: Validatable

Validates this object.

Specified by:

validate in interface Validatable

Overrides:

validate in class Interaction

Returns:

validation result

getClassTag

public java.lang.String getClassTag()

Description copied from interface: XmlNode

Gets QTI class name of this node.

QTI class name has very important role during loading/saving nodes.

For example: Java class name is AssessmentTest; QTI class name is assessmentTest.

Specified by:

getClassTag in interface XmlNode

Specified by:

getClassTag in class AbstractNode

Returns:

QTI class name of this node

getChildren

public java.util.List<? extends XmlNode> getChildren()

Gets an unmodifiable list of the child elements. Use the other methods on ChoiceInteraction to add children to the correct group.

Overrides:

getChildren in class BlockInteraction

Returns:

List of child nodes

getBlockStatics

public java.util.List<BlockStatic> getBlockStatics()

Gets blockStatic children.

Returns:

blockStatic children