com.deltalearn.rte.webservice
Interface IDataModelService

All Known Subinterfaces:

IDeltalearnService

public interface IDataModelService

Scorm data model services.

For each get/set operation, the necessary parameters are the course, SCO and user for which the request is being made.

All functions to obtain/generate data, take as a parameter the course, SCO and user for performed operation.

Version:

0.1

Method Summary

boolean	addCommentFromLms(java.lang.String userId, java.lang.String courseId, java.lang.String scoId, IComment comment) Adds a new external comment to the specified course and SCO.
IComment[]	getCommentsFromLearner(java.lang.String userId, java.lang.String courseId, java.lang.String scoId) Obtains comments for the specified user, course and SCO.
IComment[]	getCommentsFromLms(java.lang.String userId, java.lang.String courseId, java.lang.String scoId) Obtains LMS comments for the specified user, course and SCO.
CompletionStatusEnum	getCompletionStatus(java.lang.String userId, java.lang.String courseId, java.lang.String scoId) Obtains the current completion status obtained in the course and SCO for a given learner.
java.lang.String	getCompletionThreshold(java.lang.String userId, java.lang.String courseId, java.lang.String scoId) Obtains the value specified by the content creator as enough to consider the content as completed.
IInteraction[]	getInteractions(java.lang.String userId, java.lang.String courseId, java.lang.String scoId) .
java.lang.String	getMaxTimeAllowed(java.lang.String userId, java.lang.String courseId, java.lang.String scoId) Obtains the maximum time specified by the SCO creator to complete the same.
IObjective[]	getObjectives(java.lang.String userId, java.lang.String courseId, java.lang.String scoId) Obtains the objectives of a given user, course and SCO.
java.lang.String	getProgressMeasure(java.lang.String userId, java.lang.String courseId, java.lang.String scoId) Obtains the progress measure (as a numeric value, subject to each SCO) obtained by the user in the SCO.
java.lang.String	getScaledPassingScore(java.lang.String userId, java.lang.String courseId, java.lang.String scoId) Ontains the score determined by the SCO creator as enought to consider the SCO as passed (do not confuse with completed).
java.lang.String	getScore(java.lang.String userId, java.lang.String courseId, java.lang.String scoId) Returns the current attained score by the learner in the specified course and SCO.
java.lang.String	getSessionTime(java.lang.String userId, java.lang.String courseId, java.lang.String scoId) Obtains the time elapsed between the (last) user session in the specified course and SCO, using SCORM format.
SuccessStatusEnum	getSuccessStatus(java.lang.String userId, java.lang.String courseId, java.lang.String scoId) Obtains the success status obtained by the user for the specified course and SCO.
java.lang.String	getTotalTime(java.lang.String userId, java.lang.String courseId, java.lang.String scoId) Returns the total time elapsed in the course and SCO by the learner.
boolean	setCommentFromLms(java.lang.String userId, java.lang.String courseId, java.lang.String scoId, int ndx, IComment comment) Modifies values of an existing comment.

Method Detail

getCommentsFromLearner

IComment[] getCommentsFromLearner(java.lang.String userId,
                                  java.lang.String courseId,
                                  java.lang.String scoId)

Obtains comments for the specified user, course and SCO.

Parameters:

userId -

courseId -

scoId -

Returns:

the required comments

getCommentsFromLms

IComment[] getCommentsFromLms(java.lang.String userId,
                              java.lang.String courseId,
                              java.lang.String scoId)

Obtains LMS comments for the specified user, course and SCO.

Parameters:

userId -

courseId -

scoId -

Returns:

the required comments

setCommentFromLms

boolean setCommentFromLms(java.lang.String userId,
                          java.lang.String courseId,
                          java.lang.String scoId,
                          int ndx,
                          IComment comment)

Modifies values of an existing comment. There is not a mechanismo to delete these comments.

Parameters:

userId - it will not be required in the future, but a valid one has to be provided for now.

courseId -

scoId -

ndx -

commentFromLms - modified data to be saved.

Returns:

true if the comment was successfully modified, false otherwise (eg, if ndx specifies an invalid comment).

See Also:

CommentFromLms

addCommentFromLms

boolean addCommentFromLms(java.lang.String userId,
                          java.lang.String courseId,
                          java.lang.String scoId,
                          IComment comment)

Adds a new external comment to the specified course and SCO.

Parameters:

userId - it will not be required in the future, but a valid one has to be provided for now.

courseId -

scoId -

commentFromLms - new comment to store.

Returns:

true if the comment was successfully added, false if it wasn't.

See Also:

CommentFromLms

getCompletionStatus

CompletionStatusEnum getCompletionStatus(java.lang.String userId,
                                         java.lang.String courseId,
                                         java.lang.String scoId)

Obtains the current completion status obtained in the course and SCO for a given learner.

Parameters:

userId - learner id for which the query is being made.

courseId -

scoId -

Returns:

Completion status attained. The success status may very well differ from the completion status (ie, the learner may have completed, but not satisfied, the course and SCO).

See Also:

CompletionStatusEnum

getInteractions

IInteraction[] getInteractions(java.lang.String userId,
                               java.lang.String courseId,
                               java.lang.String scoId)

. * Obtains the interations of a given user, course and SCO.

Parameters:

userId -

courseId -

scoId -

Returns:

the interactions

getMaxTimeAllowed

java.lang.String getMaxTimeAllowed(java.lang.String userId,
                                   java.lang.String courseId,
                                   java.lang.String scoId)

Obtains the maximum time specified by the SCO creator to complete the same.

Parameters:

userId - it will not be required in the future, but a valid one has to be provided for now.

courseId -

scoId -

Returns:

the maximum specified time to complete the SCO in SCORM format.

getObjectives

IObjective[] getObjectives(java.lang.String userId,
                           java.lang.String courseId,
                           java.lang.String scoId)

Obtains the objectives of a given user, course and SCO.

Parameters:

userId -

courseId -

scoId -

Returns:

the required objectives.

getScore

java.lang.String getScore(java.lang.String userId,
                          java.lang.String courseId,
                          java.lang.String scoId)

Returns the current attained score by the learner in the specified course and SCO.

Parameters:

userId -

courseId -

scoId -

Returns:

score obtained for the SCO.

getSessionTime

java.lang.String getSessionTime(java.lang.String userId,
                                java.lang.String courseId,
                                java.lang.String scoId)

Obtains the time elapsed between the (last) user session in the specified course and SCO, using SCORM format. The time span is returned in SCORM format.

Parameters:

userId -

courseId -

scoId -

Returns:

the elapsed time for the user session.

getSuccessStatus

SuccessStatusEnum getSuccessStatus(java.lang.String userId,
                                   java.lang.String courseId,
                                   java.lang.String scoId)

Obtains the success status obtained by the user for the specified course and SCO.

Parameters:

userId -

courseId -

scoId -

Returns:

the success status.

See Also:

SuccessStatusEnum

getTotalTime

java.lang.String getTotalTime(java.lang.String userId,
                              java.lang.String courseId,
                              java.lang.String scoId)

Returns the total time elapsed in the course and SCO by the learner. That is, returns the sum of the time elapsed in each session the user has taken on the course and SCO. This span is returned in SCORM format.

Parameters:

userId -

courseId -

scoId -

Returns:

Similar to getSessionTime, represents the total time each user spent on the course.

See Also:

getSessionTime(java.lang.String, java.lang.String, java.lang.String)

getCompletionThreshold

java.lang.String getCompletionThreshold(java.lang.String userId,
                                        java.lang.String courseId,
                                        java.lang.String scoId)

Obtains the value specified by the content creator as enough to consider the content as completed. (does not imply the course be satisfied).

Parameters:

userId - it will not be required in the future, but a valid one has to be provided for now.

courseId -

scoId -

Returns:

the threshold value to determine SCO completion.

getProgressMeasure

java.lang.String getProgressMeasure(java.lang.String userId,
                                    java.lang.String courseId,
                                    java.lang.String scoId)

Obtains the progress measure (as a numeric value, subject to each SCO) obtained by the user in the SCO.

Parameters:

userId -

courseId -

scoId -

Returns:

the progress measure value for the SCO. It corresponds to the one obtained for each objective, but the one here it is considered global to the whole SCO. It might or might not have a relationship between them.

getScaledPassingScore

java.lang.String getScaledPassingScore(java.lang.String userId,
                                       java.lang.String courseId,
                                       java.lang.String scoId)

Ontains the score determined by the SCO creator as enought to consider the SCO as passed (do not confuse with completed). al SCO como satisfecho (no confundir con completo).

Parameters:

userId - it will not be required in the future, but a valid one has to be provided for now.

courseId -

scoId -

Returns:

the passing score specified by the SCO.