org.activemath.tutor
Class XmlrpcTutorialServer

java.lang.Object
  extended by org.activemath.tutor.XmlrpcTutorialServer

public class XmlrpcTutorialServer
extends Object


Field Summary
static String NO_COURSE
          No course is found for the given Task.
static String TASK_REJECTED
          The task is in current envirement not acceptable.
 
Constructor Summary
XmlrpcTutorialServer()
           
 
Method Summary
 String handleTask(String userId, String pedaObj, Vector contentIds)
          Return a course that helps the learner to achieve the given pedagogical task.
 String handleTask(String userID, String pedaObj, Vector contentIds, String session, String source)
          Return a course that helps the learner to achieve the given pedagogical task.
 String handleTask(String userID, String pedaObj, Vector contentIds, Vector idsToIgnore, String session, String source)
          Return a course that helps the learner to achieve the given pedagogical task.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NO_COURSE

public static final String NO_COURSE
No course is found for the given Task.

See Also:
Constant Field Values

TASK_REJECTED

public static final String TASK_REJECTED
The task is in current envirement not acceptable.

See Also:
Constant Field Values
Constructor Detail

XmlrpcTutorialServer

public XmlrpcTutorialServer()
Method Detail

handleTask

public String handleTask(String userId,
                         String pedaObj,
                         Vector contentIds)
Return a course that helps the learner to achieve the given pedagogical task.

Let the TutorialControl generate a course (OJDocument) achieving the given pedagogical objective for the contentIdentifiers, and serialise it to string, and return the string.

Parameters:
userId - the user identifier
pedaObj - the pedagogical objective (e.g., discover)
contentIds - the identifiers of the goal learning objects
Returns:
string which contains the content of the OJDocument or a string which starts with "Exception_" and contains the reason why no course could be generated.

handleTask

public String handleTask(String userID,
                         String pedaObj,
                         Vector contentIds,
                         String session,
                         String source)
Return a course that helps the learner to achieve the given pedagogical task.

Let the TutorialControl generate a course (OJDocument) achieving the given pedagogical objective for the contentIdentifiers, and serialise it to string, and return the string. The parameters session and source are used for providing additional information when the TutorialInteractionEvent is published. They can be any string but for better logging purposes should consist of the session id and the classname of the calling class.

Parameters:
userID - the user identifier
pedaObj - the pedagogical objective (e.g., discover)
contentIds - the identifiers of the goal learning objects
session - the identifier of the currents session
source - the classname of the component calling the tutorial component
Returns:
string which contains the content of the OJDocument or a string which starts with "Exception_" and contains the reason why no course could be generated.

handleTask

public String handleTask(String userID,
                         String pedaObj,
                         Vector contentIds,
                         Vector idsToIgnore,
                         String session,
                         String source)
Return a course that helps the learner to achieve the given pedagogical task.

Let the TutorialControl generate a course (OJDocument) achieving the given pedagogical objective for the contentIdentifiers, and serialise it to string, and return the string. The parameters session and source are used for providing additional information when the TutorialInteractionEvent is published. They can be any string but for better logging purposes should consist of the session id and the classname of the calling class. idsToIgnore are not returned as a result. Use this, for instance, if your book contains examples and you don't want to receive them as a result of the course generation.

Parameters:
userID - the user identifier
pedaObj - the pedagogical objective (e.g., discover)
contentIds - the identifiers of the goal learning objects
idsToIgnore - identifiers of learning objects that should be excluded as a result
session - the identifier of the currents session
source - the classname of the component calling the tutorial component
Returns:
string which contains the content of the OJDocument or a string which starts with "Exception_" and contains the reason why no course could be generated.