com.icodeon.rte.model
Class InteractionBean

java.lang.Object
  com.icodeon.rte.model.Id
      com.icodeon.rte.model.InteractionBean

All Implemented Interfaces:

java.io.Serializable

public class InteractionBean
extends Id
implements java.io.Serializable

Interactions can be thought of as a collection of information (interaction data). There are two important pieces of data that are required to be in the interaction data, an identifier (cmi.interactions.n.id) and the type of interaction (cmi.interactions.n.type). The cmi.interactions.n.type data model element is required if the Interaction includes data pertaining to either the Correct Response or Learner Response. These two pieces of information are what distinguish the interaction data from other interaction data found in the collection of interactions (considered the dependencies of the interaction data). The identifier uniquely identifies one interaction from another within the scope of the SCO. The type uniquely identifies the type of interaction (true-false, matching, etc.).

See Also:

Serialized Form

Constructor Summary

InteractionBean()
Zero argument constructor

InteractionBean(java.lang.String identifier)
Constructor with the natural primary key

InteractionBean(java.lang.String identifier, CocdBean cocd)
Constructor with the composite key

Method Summary

void	addObjectiveId(ObjectiveIdBean objectiveId) Convenience method implements the managed bi-directional association between InteractionBean and ObjectiveIdBean.
CocdBean	getCocd() Accessor method for the foreign key.
CorrectResponseBaseBean	getCorrectResponse()
java.lang.String	getDescription()
java.lang.String	getIdentifier() Accessor method for natural primary key.
long	getLatency()
LearnerResponseBaseBean	getLearnerResponse()
java.util.List	getObjectiveIds() Accessor method that establishes a bi-directional association.
java.lang.String	getResult()
java.util.Calendar	getTimestamp()
java.lang.String	getType()
java.math.BigDecimal	getWeighting()
void	setCocd(CocdBean cocd) Mutator method for the foreign key.
void	setCorrectResponse(CorrectResponseBaseBean correctResponse)
void	setDescription(java.lang.String description)
void	setIdentifier(java.lang.String identifier) Mutator method for for natural primary key.
void	setLatency(long latency)
void	setLearnerResponse(LearnerResponseBaseBean learnerResponse)
void	setObjectiveIds(java.util.List objectiveIds) Mutator method that establishes a bi-directional association.
void	setResult(java.lang.String result) The cmi.interactions.n.result data model element is a judgement of the correctness of the learner response.
void	setTimestamp(java.util.Calendar timestamp)
void	setType(java.lang.String type) The cmi.interactions.n.type data model element indicates which type of interaction is recorded in an instance of an interaction.
void	setWeighting(java.math.BigDecimal weighting) The cmi.interactions.n.weighting data model element is the weight given to the interaction that may be used by the SCO to compute a value for a score.

Methods inherited from class com.icodeon.rte.model.Id

getId, setId, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InteractionBean

public InteractionBean()

Zero argument constructor

InteractionBean

public InteractionBean(java.lang.String identifier)

Constructor with the natural primary key

Parameters:

identifier -

InteractionBean

public InteractionBean(java.lang.String identifier,
                       CocdBean cocd)

Constructor with the composite key

Parameters:

identifier -

cocd -

Method Detail

getIdentifier

public java.lang.String getIdentifier()

Accessor method for natural primary key.

Returns:

setIdentifier

public void setIdentifier(java.lang.String identifier)

Mutator method for for natural primary key.

Parameters:

cocd -

getCocd

public CocdBean getCocd()

Accessor method for the foreign key.

Returns:

setCocd

public void setCocd(CocdBean cocd)

Mutator method for the foreign key.

Parameters:

cocd -

setObjectiveIds

public void setObjectiveIds(java.util.List objectiveIds)

Mutator method that establishes a bi-directional association. The InteractionBean has a collection of objectiveId values, a one-to-many relationship. The ObjectiveIdBean has a foreign key relationship to an InteractionBean, a many-to-one relationship.

Parameters:

objectiveIds -

getObjectiveIds

public java.util.List getObjectiveIds()

Accessor method that establishes a bi-directional association.

Returns:

addObjectiveId

public void addObjectiveId(ObjectiveIdBean objectiveId)

Convenience method implements the managed bi-directional association between InteractionBean and ObjectiveIdBean.

Parameters:

objectiveId -

getLearnerResponse

public LearnerResponseBaseBean getLearnerResponse()

setLearnerResponse

public void setLearnerResponse(LearnerResponseBaseBean learnerResponse)

setCorrectResponse

public void setCorrectResponse(CorrectResponseBaseBean correctResponse)

getCorrectResponse

public CorrectResponseBaseBean getCorrectResponse()

getTimestamp

public java.util.Calendar getTimestamp()

setTimestamp

public void setTimestamp(java.util.Calendar timestamp)

getLatency

public long getLatency()

setLatency

public void setLatency(long latency)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getWeighting

public java.math.BigDecimal getWeighting()

setWeighting

public void setWeighting(java.math.BigDecimal weighting)

The cmi.interactions.n.weighting data model element is the weight given to the interaction that may be used by the SCO to compute a value for a score. The interaction weights typically are used to explain the effect of an interaction on the value of the score but are not intended to be used by systems other than the SCO to compute the score. How this value or any calculation of a total score is computed by the SCO is outside the scope of SCORM.

Parameters:

weighting -

getType

public java.lang.String getType()

setType

public void setType(java.lang.String type)

The cmi.interactions.n.type data model element indicates which type of interaction is recorded in an instance of an interaction. It is also used to determine how the interaction response should be interpreted.

Parameters:

type -

getResult

public java.lang.String getResult()

setResult

public void setResult(java.lang.String result)
               throws InvalidDataTypeException,
                      java.lang.NumberFormatException

The cmi.interactions.n.result data model element is a judgement of the correctness of the learner response.

Parameters:

result -

Throws:

InvalidDataTypeException

java.lang.NumberFormatException