Package org.sakaiproject.entitybroker.entityprovider.capabilities

Interface LearningTrackable

All Superinterfaces:

EntityProvider

public interface LearningTrackable
extends EntityProvider

This capability is for tracking learning events (LRS statements) related to this entity
If more advanced control is needed then use of the full LRS_Statement in then LearningResourceStoreService. This is one of the capability extensions for the EntityProvider interface

Author:

Aaron Zeckoski (azeckoski @ unicon.net) (azeckoski @ vt.edu)

Method Summary

Modifier and Type	Method	Description
void	registerStatement(String actorEmail, String verbStr, String objectURI, Boolean resultSuccess, Float resultScaledScore)	Send a simple learning activity (LRS) statement with an optional result Statements are the bread and butter of Experience API (a.k.a.

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.EntityProvider

getEntityPrefix

Method Detail

registerStatement

void registerStatement(String actorEmail,
                       String verbStr,
                       String objectURI,
                       Boolean resultSuccess,
                       Float resultScaledScore)

Send a simple learning activity (LRS) statement with an optional result Statements are the bread and butter of Experience API (a.k.a. TinCanAPI). They dictate the format for the specific moments in a stream of activity. They convey an experience which has occurred, or may be occurring, and typically can be stated in clear language, for instance, "Bob completed 'Truck Driving Training Level 1'". NOTE: OPTIONAL params can be null, all other MUST be set and NOT empty strings NOTE: the origin used for the statement registration will be the entity prefix

Parameters:

actorEmail - the user email address, "I"

verbStr - a string indicating the action, "did"

objectURI - URI indicating the object of the statement, "this"

resultSuccess - [OPTIONAL] true if the result was successful (pass) or false if not (fail), "well"

resultScaledScore - [OPTIONAL] Score from -1.0 to 1.0 where 0=0% and 1.0=100%

Throws:

IllegalArgumentException - if required fields are left blank or null