org.sakaiproject.entitybroker.entityprovider.extension

Interface LearningTrackingProvider

All Known Subinterfaces:

EntityBroker, ExternalIntegrationProvider

public interface LearningTrackingProvider

This provides for tracking learning events (LRS statements) related to an entity (by prefix)
If more advanced control is needed then use of the full LRS_Statement in then LearningResourceStoreService.

Author:

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

Method Summary

Modifier and Type	Method and Description
void	registerStatement(String prefix, 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.

Method Detail

registerStatement

void registerStatement(String prefix,
                       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

Parameters:

prefix - the string which represents a type of entity handled by an entity provider

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 the prefix is not set or other required fields are left blank or null

See Also:

#LearningResourceStoreService.registerStatement(LRS_Statement statement, String origin)