|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TutorInterface
The interface class for the Java Intelligent Tutor Authoring Shell (JITAS) class library (core classes). All other applications will use this class to interface with JITAS. This class provides all the necessary functionality for a higher level application to act as an Intelligent Tutoring System.
Method Summary | |
---|---|
void |
addAllowedDomain(java.lang.String userName,
java.lang.String domainName)
This method will attempt to give the user access to the specific domain. |
void |
addUser(java.lang.String userName,
java.lang.String password,
java.lang.String domainName)
Adds a user to the JITAS system and authorize them to access domains. |
void |
changePassword(java.lang.String userName,
java.lang.String oldPassword,
java.lang.String newPassword)
Change user's existing password to a new password. |
void |
deleteUser(java.lang.String userName)
Delete a user from the JITAS system. |
java.util.Set<java.lang.String> |
getAllDomainNames()
Returns a set of names of all the Domains that JITAS "knows" about. |
java.util.Map<java.lang.String,java.lang.String> |
getAllLongDomainNames()
Gets all the names for the currently loaded domains as a map of |
java.util.SortedMap<java.lang.Integer,Problem> |
getAllProblems(java.lang.String userName,
java.lang.String domainName)
Gets all the problems in the current working subdomain of the domain and returns them as a SortedMap. |
boolean |
getLoginStatus(java.lang.String userName,
java.lang.String domainName)
Get the login status for the user, for all the domains a student is logged into (i.e. |
Problem |
getNextProblem(int problemNumber,
java.lang.String userName,
java.lang.String domainName)
Gets the next problem, specified by the user. |
Problem |
getNextProblem(java.lang.String userName,
java.lang.String domainName)
Gets the next problem, based on the current problem number. |
Problem |
getProblem(java.lang.String userName,
java.lang.String domainName)
Gets the next problem, specified by the system. |
java.lang.String |
getProblemStatus(java.lang.String userName,
java.lang.String domainName,
int problemID)
Get the status of a problem for a particular domain and user. |
java.util.Set<java.lang.String> |
getSubdomains(java.lang.String domainName)
Returns a set of all the subdomain names in a given domain, as Strings. |
void |
loadDomain(java.lang.String domainName)
Loads a specified Domain from a .xml file. |
void |
login(java.lang.String userName,
java.lang.String password,
java.lang.String domainName)
Login method. |
void |
logout(java.lang.String userName,
java.lang.String domainName)
Logs a specified user out of the domain. |
void |
removeUser(java.lang.String userName,
java.lang.String domainName)
Remove a user from a domain. |
void |
selectSubdomain(java.lang.String userName,
java.lang.String subdomainName,
java.lang.String domainName)
Allows a user to select a subdomain to work on. |
void |
setCustomFeedback(java.lang.String domainName,
java.lang.String fileName)
Set the custom feedback object for a domain. |
void |
setCustomProblemSelectionAlgorithm(java.lang.String domainName,
java.lang.String fileName)
Set the custom problem selection algorithm for a domain. |
Feedback |
submitSolution(Solution studentSolution,
java.lang.String userName,
java.lang.String domainName)
Used when a student wishes to submit their solution to the current problem. |
Method Detail |
---|
void login(java.lang.String userName, java.lang.String password, java.lang.String domainName) throws DomainNotFoundException, DomainNotLoadedException, InvalidLoginException, UserNotFoundException, java.rmi.RemoteException
userName
- The user name of the user.password
- The password for the user.domainName
- The Domain name the user wants to log into.
DomainNotFoundException
- If the domain is not found.
DomainNotLoadedException
- If the domain is not loaded.
InvalidLoginException
- If the login is invalid (wrong password).
UserNotFoundException
- If the user does not exist.
java.rmi.RemoteException
void logout(java.lang.String userName, java.lang.String domainName) throws DomainNotFoundException, DomainNotLoadedException, UserNotFoundException, UserNotLoggedInException, java.rmi.RemoteException
userName
- The user to be logged out.domainName
- The Domain name the user wants to log out of.
DomainNotFoundException
- If the domain is not found.
DomainNotLoadedException
- If the domain is not loaded.
UserNotFoundException
- If the user could not be found.
UserNotLoggedInException
- If the user was not logged in.
java.rmi.RemoteException
boolean getLoginStatus(java.lang.String userName, java.lang.String domainName) throws UserNotFoundException, java.rmi.RemoteException
userName
- The user name of the user who wants to log out.domainName
- The Domain name.
UserNotFoundException
- If the user could not be found.
java.rmi.RemoteException
void addUser(java.lang.String userName, java.lang.String password, java.lang.String domainName) throws AddUserDeniedException, DomainNotFoundException, DomainNotLoadedException, IllegalUserNameException, StudentModelAlreadyExistsException, java.rmi.RemoteException
userName
- The user name of the new user.password
- The password for the new user.domainName
- The Domain name the user wants to create an account for.
AddUserDeniedException
- If new users are not allowed to be added to the domain.
DomainNotFoundException
- If the domain could not be found.
DomainNotLoadedException
- If the requested domain is not loaded.
IllegalUserNameException
- If the user specified an illegal username.
StudentModelAlreadyExistsException
- If a student model already exists.
java.rmi.RemoteException
void removeUser(java.lang.String userName, java.lang.String domainName) throws DomainNotFoundException, DomainNotLoadedException, UserNotFoundException, UserNotLoggedInException, java.rmi.RemoteException
userName
- The user name of the user.domainName
- The name of the Domain the user is to be removed from.
DomainNotFoundException
- If the domain could not be found.
DomainNotLoadedException
- If the requested domain is not loaded.
UserNotFoundException
- If the user could not be found.
UserNotLoggedInException
- If the user was not logged in.
java.rmi.RemoteException
void deleteUser(java.lang.String userName) throws DomainNotFoundException, DomainNotLoadedException, UserNotFoundException, UserNotLoggedInException, java.rmi.RemoteException
userName
- The user name of the user.
DomainNotFoundException
- If the domain could not be found.
DomainNotLoadedException
- If the user is logged into a domain that's not loaded.
UserNotFoundException
- If the user could not be found.
UserNotLoggedInException
- If the user was not logged in.
java.rmi.RemoteException
void addAllowedDomain(java.lang.String userName, java.lang.String domainName) throws AddUserDeniedException, DomainNotFoundException, DomainNotLoadedException, StudentModelAlreadyExistsException, UserNotFoundException, java.rmi.RemoteException
userName
- the user name of the userdomainName
- the name of the domain the student wishes to have access to.
AddUserDeniedException
- If new users are not allowed to be added to the domain.
DomainNotFoundException
- thrown if the domain with domainName is not found.
DomainNotLoadedException
- If the requested domain is not loaded.
StudentModelAlreadyExistsException
- If a student model already exists
UserNotFoundException
- thrown if the student with user name userName is not found
java.rmi.RemoteException
void changePassword(java.lang.String userName, java.lang.String oldPassword, java.lang.String newPassword) throws InvalidPasswordException, UserNotFoundException, java.rmi.RemoteException
userName
- The user name of the user.oldPassword
- The users current passwordnewPassword
- The new password that the user wants to change to.
InvalidPasswordException
- if the current password given is invalid
UserNotLoggedInException
- If the user was not logged in.
java.rmi.RemoteException
UserNotFoundException
java.util.Set<java.lang.String> getAllDomainNames() throws java.rmi.RemoteException
java.rmi.RemoteException
java.util.Map<java.lang.String,java.lang.String> getAllLongDomainNames() throws java.rmi.RemoteException
java.rmi.RemoteException
java.util.Set<java.lang.String> getSubdomains(java.lang.String domainName) throws DomainNotFoundException, DomainNotLoadedException, java.rmi.RemoteException
domainName
- The name of the domain.
DomainNotFoundException
- if the domain is not found (or not loaded).
DomainNotLoadedException
- If the requested domain is not loaded
java.rmi.RemoteException
void loadDomain(java.lang.String domainName) throws DomainNotFoundException, jess.JessException, java.rmi.RemoteException
domainName
- The name of the domain you want to load.
DomainNotFoundException
- if the Domain is not found.
jess.JessException
- If something goes wrong in Jess (the rule engine)
java.rmi.RemoteException
void selectSubdomain(java.lang.String userName, java.lang.String subdomainName, java.lang.String domainName) throws DomainNotFoundException, DomainNotLoadedException, ProblemsNotFoundException, SubdomainNotFoundException, UserNotFoundException, UserNotLoggedInException, java.rmi.RemoteException
userName
- The name of the user.domainName
- The name of the domain the student is working on.subdomainName
- The name of the subdomain the student wants to work on.
DomainNotFoundException
- If the domain could not be found.
DomainNotLoadedException
- If the requested domain is not loaded.
ProblemsNotFoundException
- If no problems could be found for the subdomain.
SubdomainNotFoundException
- If the Subdomain is not found.
UserNotFoundException
- If the user could not be found.
UserNotLoggedInException
- If the user is not logged in to the domain.
java.rmi.RemoteException
Problem getNextProblem(int problemNumber, java.lang.String userName, java.lang.String domainName) throws DomainNotFoundException, DomainNotLoadedException, InvalidProblemException, UserNotFoundException, UserNotLoggedInException, java.rmi.RemoteException
problemNumber
- The number(id) of the problem the user wants.userName
- The name of the user.domainName
- The name of the domain.
DomainNotFoundException
- If the domain cannot be found.
DomainNotLoadedException
- If the requested domain is not loaded.
InvalidProblemException
- If the problem cannot be found.
UserNotFoundException
- If the user could not be found.
UserNotLoggedInException
- If the user is not logged in to the domain.
java.rmi.RemoteException
Problem getNextProblem(java.lang.String userName, java.lang.String domainName) throws DomainNotFoundException, DomainNotLoadedException, InvalidProblemException, UserNotFoundException, UserNotLoggedInException, java.rmi.RemoteException
userName
- The name of the user who wants the problem.domainName
- The name of the domain.
DomainNotFoundException
- If the domain cannot be found.
DomainNotLoadedException
- If the requested domain is not loaded.
InvalidProblemException
- If the problem cannot be found.
UserNotFoundException
- If the user could not be found.
UserNotLoggedInException
- If the user is not logged in to the domain.
java.rmi.RemoteException
void setCustomProblemSelectionAlgorithm(java.lang.String domainName, java.lang.String fileName) throws DomainNotFoundException, DomainNotLoadedException
domainName
- The domain namefileName
- The class name of the class in the jar
DomainNotFoundException
- If the domain doesn't exist
DomainNotLoadedException
- If the domain is not loadedvoid setCustomFeedback(java.lang.String domainName, java.lang.String fileName) throws DomainNotFoundException, DomainNotLoadedException
domainName
- The domain nameefileName
- The class name of the class in the jar
DomainNotFoundException
- If the domain doesn't exist
DomainNotLoadedException
- If the domain is not loadedProblem getProblem(java.lang.String userName, java.lang.String domainName) throws DomainNotFoundException, DomainNotLoadedException, java.lang.InstantiationException, java.lang.IllegalAccessException, java.rmi.RemoteException, UserNotFoundException, InvalidProblemException
userName
- The name of the user who wants the problem.domainName
- The name of the domain.
DomainNotFoundException
- If the domain cannot be found.
DomainNotLoadedException
- If the requested domain is not loaded.
java.lang.InstantiationException
- If instantiation fails.
java.lang.IllegalAccessException
- when an application tries to reflectively
create an instance (other than an array),set or get a field, or invoke a method.
java.rmi.RemoteException
UserNotFoundException
InvalidProblemException
java.util.SortedMap<java.lang.Integer,Problem> getAllProblems(java.lang.String userName, java.lang.String domainName) throws DomainNotFoundException, DomainNotLoadedException, UserNotFoundException, UserNotLoggedInException, java.rmi.RemoteException
userName
- The name of the user who wants the problem.domainName
- The name of the domain.
DomainNotFoundException
- If the domain cannot be found.
DomainNotLoadedException
- If the requested domain is not loaded.
UserNotFoundException
- If the user could not be found.
UserNotLoggedInException
- If the user is not logged in to the domain.
java.rmi.RemoteException
java.lang.String getProblemStatus(java.lang.String userName, java.lang.String domainName, int problemID) throws UserNotFoundException, UserNotLoggedInException, DomainNotFoundException, DomainNotLoadedException, java.rmi.RemoteException
userName
- The name of the userdomainName
- The name of the domainproblemID
- The id of the problem you want the status of
UserNotFoundException
- If the user could not be found.
UserNotLoggedInException
- If the user is not logged in to the domain.
DomainNotFoundException
- If the domain cannot be found.
DomainNotLoadedException
- If the requested domain is not loaded.
java.rmi.RemoteException
Feedback submitSolution(Solution studentSolution, java.lang.String userName, java.lang.String domainName) throws DomainNotFoundException, DomainNotLoadedException, InvalidSolutionException, StudentModelNotFoundException, UserNotFoundException, UserNotLoggedInException, jess.JessException, java.rmi.RemoteException
studentSolution
- the students attempt, in a String of key-value pairs.userName
- The name of the user who wants the problem.domainName
- The name of the domain.
DomainNotFoundException
- If the supplied domain cannot be found.
DomainNotLoadedException
- If the requested domain is not loaded.
InvalidSolutionException
- If either the students or ideal solution is invalid.
StudentModelNotFoundException
- If the students StudentModel cannot be found.
UserNotFoundException
- If the user could not be found.
UserNotLoggedInException
- If the user is not logged in to the domain.
jess.JessException
- If something goes wrong in Jess (the rule engine)
java.rmi.RemoteException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |