com.deltalearn.rte.webservice.data
Interface IInteraction


public interface IInteraction

Represents an interaction, such as a fill-in, multiple-choice or selection question..

Interactions are defined by a SCO with the cmi.interactions data model.

Version:
0.1

Method Summary
 java.lang.String[] getCorrectResponses()
          Returns the possible correct responses of this interaction.
 java.lang.String getDescription()
          Returns a description set by the SCO of this interaction.
 java.lang.String getId()
          Returns the identifier set by the SCO of this interaction.
 java.lang.String getLatency()
          Returns the time taken to fulfill the interaction.
 java.lang.String getLearnerResponse()
          Returns the response given by the learner.
 java.lang.String[] getObjectiveIds()
          Returns the identifiers of the objectives associated to this interaction.
 IInteractionResult getResult()
          Returns the overall result of this interaction.
 ITime getTimestamp()
          Returns the time at which this interaction was started.
 InteractionTypeEnum getType()
          Returns the type of interaction set by the SCO.
 

Method Detail

getId

java.lang.String getId()
Returns the identifier set by the SCO of this interaction.

Returns:
the identifier

getDescription

java.lang.String getDescription()
Returns a description set by the SCO of this interaction. May be null.

Returns:
the description

getType

InteractionTypeEnum getType()
Returns the type of interaction set by the SCO.

Returns:
the type of interaction

getObjectiveIds

java.lang.String[] getObjectiveIds()

Returns the identifiers of the objectives associated to this interaction.

A SCO may associate interaction to objective identifiers. The objective identifiers may or may not correspond to the objective identifiers found in the Objectives data model element (cmi.objectives.n.id). Whether or not there is a relationship to the objective identifiers is implementation specific. The SCO may be designed to track this information and relationship.

Returns:
the identifiers of the objectives associated to this interaction

getCorrectResponses

java.lang.String[] getCorrectResponses()
Returns the possible correct responses of this interaction. The response given by the user can be obtained with getLearnerResponse().

Returns:
the possible correct responses of this interaction
See Also:
getLearnerResponse()

getTimestamp

ITime getTimestamp()
Returns the time at which this interaction was started. May be null.

Returns:
the time at which this interaction was started

getLatency

java.lang.String getLatency()
Returns the time taken to fulfill the interaction. TODO: return an ITimeSpan

Returns:
the time taken to fulfill the interaction

getLearnerResponse

java.lang.String getLearnerResponse()
Returns the response given by the learner.

Returns:
the response given by the learner
See Also:
getCorrectResponses()

getResult

IInteractionResult getResult()
Returns the overall result of this interaction.

Returns:
the overall result of this interaction