org.activemath.webapp.base.external.ilias
Interface ILIASSoapWebservicePortType

All Superinterfaces:

Remote

All Known Implementing Classes:

ILIASSoapWebserviceBindingStub

public interface ILIASSoapWebservicePortType
extends Remote

Method Summary

int	addCourse(String sid, int target_id, String crs_xml) ILIAS addCourse().
int	addExercise(String sid, int target_id, String xml) ILIAS addExercise(): create exercise, put it into target (ref_id) and update exercise properties from xml (see ilias_exercise_3_8.dtd for details).
int	addFile(String sid, int target_id, String xml) ILIAS addFile(): create file, put it into target (ref_id) and update file properties from xml (see ilias_file_3_8.dtd for details).
int	addGroup(String sid, int target_id, String group_xml) ILIAS addGroup(): Add grop according to valid group XML
int	addObject(String sid, int target_id, String object_xml) ILIAS addObject.
int	addReference(String sid, int source_id, int target_id) ILIAS addReference.
int[]	addRole(String sid, int target_id, String obj_xml) ILIAS addRole(): Creates new role under given node.
int[]	addRoleFromTemplate(String sid, int target_id, String obj_xml, int role_template_id) ILIAS addRole(): Creates new role under given node.
int	addUser(String sid, IlUserData user_data, int global_role_id) ILIAS addUser() user.
boolean	addUserRoleEntry(String sid, int user_id, int role_id) ILIAS addUserRoleEntry.
boolean	assignCourseMember(String sid, int course_id, int user_id, String type) ILIAS assignCourseMember().
boolean	assignGroupMember(String sid, int group_id, int user_id, String type) ILIAS assignGroupMember().
int	copyObject(String sid, String xml) ILIAS copyObject(): returns reference of copy, if copy is created directly, or the ref id of the target if copy is in progress.
boolean	deleteCourse(String sid, int course_id) ILIAS deleteCourse().
boolean	deleteExpiredDualOptInUserObjects(String sid, int usr_id) ILIAS deleteExpiredDualOptInUserObjects(): Deletes expired user accounts caused by unconfirmed registration links in "dual opt in" registration method
boolean	deleteObject(String sid, int reference_id) ILIAS deleteObject.
boolean	deleteRole(String sid, int role_id) ILIAS deleteRole(): Deletes an role and all user assignments.
boolean	deleteUser(String sid, int user_id) ILIAS deleteUser().
boolean	deleteUserRoleEntry(String sid, int user_id, int role_id) ILIAS deleteUserRoleEntry.
boolean	excludeCourseMember(String sid, int course_id, int user_id) ILIAS excludeCourseMember().
boolean	excludeGroupMember(String sid, int group_id, int user_id) ILIAS excludeGroupMember().
String	getClientInfoXML(String clientid) ILIAS getClientInfoXML(): returns XML following installation_info dtd, contains the client the data of given client id
String	getCoursesForUser(String sid, String parameters) ILIAS getTestResults(): returns XMLResultSet with columns ref_id, course xml.
String	getCourseXML(String sid, int course_id) ILIAS getCourseXML().
String	getExerciseXML(String sid, int ref_id, int attachment_mode) ILIAS getExerciseXML(): returns xml description of exercise.
String	getFileXML(String sid, int ref_id, int attachment_mode) ILIAS getFileXML(): returns xml description of file.
String	getGroup(String sid, int ref_id) ILIAS getGroup(): get xml description of grouip with given reference id.
String	getGroupsForUser(String sid, String parameters) ILIAS getTestResults(): returns XMLResultSet with columns ref_id, group xml.
String	getIMSManifestXML(String sid, int ref_id) ILIAS getIMSManifestXML(): returns xml of ims manifest file (scorm learning module) referred by refid
String	getInstallationInfoXML() ILIAS getInstallationInfoXML(): returns XML following installation_info dtd
String	getLocalRoles(String sid, int ref_id) ILIAS getLocalRoles(): Get all local roles assigned to an specific object.
String	getNIC(String sid) ILIAS getNIC(): DEPRECATED: use getClientInfoXML instead. was: return client information from current client as xml result set containing installation_id, installation_version, installation_url, installation_description, installation_language_default as columns
int	getNrOfQuestionsInPass(String sid, long active_id, int pass) ILIAS getNrOfQuestionsInPass: Returns the question count for a given test user in a given pass.
String	getObjectByReference(String sid, int reference_id, int user_id) ILIAS getObjectByReference().
String	getObjectsByTitle(String sid, String title, int user_id) ILIAS getObjectsByTitle().
IlOperation[]	getObjectTreeOperations(String sid, int ref_id, int user_id) ILIAS getObjectTreeOperations(): Get all granted permissions for all references of an object for a specific user.
int	getObjIdByImportId(String sid, String import_id) ILIAS getObjIdByImportId().
int[]	getObjIdsByRefIds(String sid, int[] ref_ids) ILIAS getObjIdsForRefIds: Returns a array of object ids which match the references id, given by a comma seperated string.
IlOperation[]	getOperations(String sid) ILIAS getOperations(): get complete set of RBAC operations.
String	getPathForRefId(String sid, int ref_id) ILIAS getPathForRefId(): returns XMLResultSet with columns ref_id, type and title.
int	getPositionOfQuestion(String sid, long active_id, int question_id, int pass) ILIAS getPositionOfQuestion: Returns the position of a given question for a given user in a given test pass.
double[]	getPreviousReachedPoints(String sid, long active_id, int question_id, int pass) ILIAS getPreviousReachedPoints: Returns an array of reached points for the previous questions in a given test pass.
String[]	getQuestionSolution(String sid, long active_id, int question_id, int pass) ILIAS getQuestionSolution: Typically called from external assessment questions to retrieve the previous input of a user.
int[]	getRefIdsByImportId(String sid, String import_id) ILIAS getRefIdsByImportId().
int[]	getRefIdsByObjId(String sid, String obj_id) ILIAS getRefIdsByObjId().
String	getRoles(String sid, String role_type, String id) ILIAS getRoles():if id equals -1, get all roles specified by type (global|local|user|user_login|template or empty), if type is empty all roles with all types are delivered, if id > -1 and role_type <> user or user_login, delivers all roles which belong to a repository object with specified ref_id, if roletype is user a numeric id is interpreted as userid, if roletype is user_login it is interpreted as login,if roletype is template all role templates will be listed
String	getSCORMCompletionStatus(String sid, int usr_id, int ref_id) ILIAS getSCORMCompletionStatus(): returns a completion status of a scorm module
String	getStructureObjects(String sid, int ref_id) ILIAS getStructureObjects: delivers structure of content objects like learning modules (chapters/pages) or glossary (terms)
String	getTestResults(String sid, int ref_id, boolean sum_only) ILIAS getTestResults(): returns XMLResultSet with sum only = true: user_id, login, firstname, lastname, matriculation, maximum points, received points sum only = false: user_id, login, firstname, lastname, matriculation, question id, question title, question points, received points
String[]	getTestUserData(String sid, long active_id) ILIAS getTestUserData: Typically called from external assessment questions to retrieve data of the active user.
String	getTreeChilds(String sid, int ref_id, String[] types, int user_id) ILIAS getTreeChilds(): Get all child objects of a given object.Choose array of types to filter the output.
IlUserData	getUser(String sid, int user_id) ILIAS getUser(): get complete set of user data.
int	getUserIdBySid(String sid) ILIAS getUserIdBySid(): returns an ILIAS usr_id for the given sid
String	getUserRoles(String sid, int user_id) ILIAS getUserRoles(): Get all local roles assigned to an specific user.
String	getUsersForContainer(String sid, int ref_id, int attach_roles, int active) ILIAS getUsersForContainer(): get all users of a specific ref_id, which can be crs, group, category or user folder (value: -1).
String	getUsersForRole(String sid, int role_id, int attach_roles, int active) ILIAS getUsersForRole(): get all users of a role with specified id, specify attach_roles to 1, to attach all role assignmnents; specify active: 1, to import active only, 0: inactive only, -1: both
String	getUserXML(String sid, int[] user_ids, int attach_roles) ILIAS getUserXML(): get xml records for user ids, e.g. retrieved vom members of course xml.
String	getXMLTree(String sid, int ref_id, String[] types, int user_id) ILIAS getXMLTree(): Returns a xml stream with the subtree objects.
boolean	grantPermissions(String sid, int ref_id, int role_id, int[] operations) ILIAS grantPermissions(): Grant permissions for a specific role on an object.
boolean	groupExists(String sid, String title) ILIAS addGroup(): Check if group with given name exists.
boolean	handleECSTasks(String sid) ILIAS handleECSTasks(): Only for internal usage.Syntax, parameters may change in future releases.
boolean	hasNewMail(String sid) ILIAS hasNewMail(): Checks whether the current authenticated user has a new mail.
boolean	hasSCORMCertificate(String sid, int ref_id, int usr_id) ILIAS hasSCORMCertificate(): returns true if a certficate is available for a user referred by usr_id in a SCORM learning module referred by ref_id
int	ilClone(String sid, int copy_identifier) ILIAS ilClone(): Only for internal usage.Syntax, parameters may change in future releases.
boolean	ilCloneDependencies(String sid, int copy_identifier) ILIAS ilCloneDependencies(): Only for internal usage.Syntax, parameters may change in future releases.
String	importUsers(String sid, int folder_id, String usr_xml, int conflict_rule, int send_account_mail) ILIAS import users into folder id, which should be ref_id of folder or user folder (-1:System user folder, 0: checks access at user level, otherwise refid): conflict_rule: IL_FAIL_ON_CONFLICT = 1, IL_UPDATE_ON_CONFLICT = 2, IL_IGNORE_ON_CONFLICT = 3.
int	isAssignedToCourse(String sid, int course_id, int user_id) ILIAS isAssignedToCourse().
int	isAssignedToGroup(String sid, int group_id, int user_id) ILIAS isAssignedToGroup().
String	login(String client, String username, String password) ILIAS login function
String	loginCAS(String client, String PT, String user) ILIAS login function via CAS
String	loginLDAP(String client, String username, String password) ILIAS login function via LDAP
boolean	logout(String sid) ILIAS logout function
int	lookupUser(String sid, String user_name) ILIAS lookupUser(): check if username exists.
boolean	moveObject(String sid, int ref_id, int target_id) ILIAS moveObject(): returns true, if object with refid could be successfully moved to target id, other it raises an error.
boolean	removeFromSystemByImportId(String sid, String import_id) ILIAS removeFromSystemByImportId().
boolean	revokePermissions(String sid, int ref_id, int role_id) ILIAS revokePermissions(): Revoke all permissions for a specific role on an object.
boolean	saveQuestion(String sid, long active_id, long question_id, int pass, String[] solution) ILIAS saveQuestion: Saves the result of a question in a given test pass for the active test user.
boolean	saveQuestionResult(String sid, int user_id, int test_id, int question_id, int pass, String[] solution) ILIAS saveQuesionResult: Typically called from an external assessment question to save the user input.
String	saveQuestionSolution(String sid, long active_id, long question_id, int pass, String solution) ILIAS saveQuestionSolution: Saves the result of a question in a given test pass for the active test user.
String	searchObjects(String sid, String[] types, String key, String combination, int user_id) ILIAS searchObjects(): Searches for objects.
String	searchRoles(String sid, String key, String combination, String role_type) ILIAS searchRoles(): returns XML following role dtd with search results for given role type and search terms.
String	searchUser(String sid, String[] key_fields, String query_operator, String[] key_values, int attach_roles, int active) ILIAS searchUser(): get all users, which match a query, consisting of the keyfields, matched with values of the field values, concatenated with the logical query operator.
boolean	sendMail(String sid, String rcp_to, String rcp_cc, String rcp_bcc, String sender, String subject, String message, String attachments) ILIAS sendMail(): Send mime mails according to xml description.
boolean	updateCourse(String sid, int course_id, String xml) ILIAS updateCourse().
boolean	updateExercise(String sid, int ref_id, String xml) ILIAS updateExercise():update existing exercise, update exercise properties from xml (see ilias_exercise_3_8.dtd for details). obj_id in xml must match according obj id of refid.!
boolean	updateFile(String sid, int ref_id, String xml) ILIAS updateFile():update existing file, update file properties from xml (see ilias_file_3_8.dtd for details). obj_id in xml must match according obj id of refid.!
boolean	updateGroup(String sid, int ref_id, String xml) ILIAS updateGroup(): update existing group using ref id and group xml (see DTD).
boolean	updateObjects(String sid, String object_xml) ILIAS updateObjects.
boolean	updatePassword(String sid, int user_id, String new_password) ILIAS updatePassword().
boolean	updateUser(String sid, IlUserData user_data) ILIAS updateUser().

Method Detail

login

String login(String client,
             String username,
             String password)
             throws RemoteException

ILIAS login function

Throws:

RemoteException

loginCAS

String loginCAS(String client,
                String PT,
                String user)
                throws RemoteException

ILIAS login function via CAS

Throws:

RemoteException

loginLDAP

String loginLDAP(String client,
                 String username,
                 String password)
                 throws RemoteException

ILIAS login function via LDAP

Throws:

RemoteException

logout

boolean logout(String sid)
               throws RemoteException

ILIAS logout function

Throws:

RemoteException

lookupUser

int lookupUser(String sid,
               String user_name)
               throws RemoteException

ILIAS lookupUser(): check if username exists. Return usr_id or 0 if lookup fails.

Throws:

RemoteException

getUser

IlUserData getUser(String sid,
                   int user_id)
                   throws RemoteException

ILIAS getUser(): get complete set of user data.

Throws:

RemoteException

updateUser

boolean updateUser(String sid,
                   IlUserData user_data)
                   throws RemoteException

ILIAS updateUser(). DEPRECATED: Use importUsers() for modifications of user data. Updates all user data. Use getUser(), then modify desired fields and finally start the updateUser() call.

Throws:

RemoteException

updatePassword

boolean updatePassword(String sid,
                       int user_id,
                       String new_password)
                       throws RemoteException

ILIAS updatePassword(). Updates password of given user. Password must be MD5 hash

Throws:

RemoteException

addUser

int addUser(String sid,
            IlUserData user_data,
            int global_role_id)
            throws RemoteException

ILIAS addUser() user. DEPRECATED: Since it is not possible to add new user data fields without breaking the backward compatability, this method is deprecated. Please use importUser() instead. Add new ILIAS user. Requires complete or subset of user_data structure

Throws:

RemoteException

deleteUser

boolean deleteUser(String sid,
                   int user_id)
                   throws RemoteException

ILIAS deleteUser(). Deletes all user related data (Bookmarks, Mails ...)

Throws:

RemoteException

addCourse

int addCourse(String sid,
              int target_id,
              String crs_xml)
              throws RemoteException

ILIAS addCourse(). Course import. See ilias_course_0_1.dtd for details about course xml structure

Throws:

RemoteException

deleteCourse

boolean deleteCourse(String sid,
                     int course_id)
                     throws RemoteException

ILIAS deleteCourse(). Deletes a course. Delete courses are stored in "Trash" and can be undeleted in the ILIAS administration.

Throws:

RemoteException

assignCourseMember

boolean assignCourseMember(String sid,
                           int course_id,
                           int user_id,
                           String type)
                           throws RemoteException

ILIAS assignCourseMember(). Assigns an user to an existing course. Type should be "Admin", "Tutor" or "Member"

Throws:

RemoteException

excludeCourseMember

boolean excludeCourseMember(String sid,
                            int course_id,
                            int user_id)
                            throws RemoteException

ILIAS excludeCourseMember(). Excludes an user from an existing course.

Throws:

RemoteException

isAssignedToCourse

int isAssignedToCourse(String sid,
                       int course_id,
                       int user_id)
                       throws RemoteException

ILIAS isAssignedToCourse(). Checks whether an user is assigned to a given course. Returns 0 => not assigned, 1 => course admin, 2 => course member or 3 => course tutor

Throws:

RemoteException

getCourseXML

String getCourseXML(String sid,
                    int course_id)
                    throws RemoteException

ILIAS getCourseXML(). Get a xml description of a specific course.

Throws:

RemoteException

updateCourse

boolean updateCourse(String sid,
                     int course_id,
                     String xml)
                     throws RemoteException

ILIAS updateCourse(). Update course settings, assigned members, tutors, administrators with a given xml description

Throws:

RemoteException

getObjIdByImportId

int getObjIdByImportId(String sid,
                       String import_id)
                       throws RemoteException

ILIAS getObjIdByImportId(). Get the obj_id of an ILIAS obj by a given import id.

Throws:

RemoteException

getRefIdsByImportId

int[] getRefIdsByImportId(String sid,
                          String import_id)
                          throws RemoteException

ILIAS getRefIdsByImportId(). Get all reference ids by a given import id.

Throws:

RemoteException

getRefIdsByObjId

int[] getRefIdsByObjId(String sid,
                       String obj_id)
                       throws RemoteException

ILIAS getRefIdsByObjId(). Get all reference ids by a given object id.

Throws:

RemoteException

getObjectByReference

String getObjectByReference(String sid,
                            int reference_id,
                            int user_id)
                            throws RemoteException

ILIAS getObjectByReference(). Get XML-description of an ILIAS object. If a user id is given, this methods also checks the permissions of that user on the object.

Throws:

RemoteException

getObjectsByTitle

String getObjectsByTitle(String sid,
                         String title,
                         int user_id)
                         throws RemoteException

ILIAS getObjectsByTitle(). Get XML-description of an ILIAS object with given title. If a user id is given this method also checks the permissions of that user on the object.

Throws:

RemoteException

searchObjects

String searchObjects(String sid,
                     String[] types,
                     String key,
                     String combination,
                     int user_id)
                     throws RemoteException

ILIAS searchObjects(): Searches for objects. Key is within "title" or "description" Typical calls are searchObject($sid,array("lm","crs"),"\"this and that\"","and"); If an optional user id is given, this methods also return the permissions for that user on the found objects

Throws:

RemoteException

getTreeChilds

String getTreeChilds(String sid,
                     int ref_id,
                     String[] types,
                     int user_id)
                     throws RemoteException

ILIAS getTreeChilds(): Get all child objects of a given object.Choose array of types to filter the output. Choose empty type array to receive all object types

Throws:

RemoteException

getXMLTree

String getXMLTree(String sid,
                  int ref_id,
                  String[] types,
                  int user_id)
                  throws RemoteException

ILIAS getXMLTree(): Returns a xml stream with the subtree objects.

Throws:

RemoteException

addObject

int addObject(String sid,
              int target_id,
              String object_xml)
              throws RemoteException

ILIAS addObject. Create new object based on xml description under a given node ("category,course,group or folder). Return created reference id of the new object.

Throws:

RemoteException

updateObjects

boolean updateObjects(String sid,
                      String object_xml)
                      throws RemoteException

ILIAS updateObjects. Update object data (title,description,owner)

Throws:

RemoteException

addReference

int addReference(String sid,
                 int source_id,
                 int target_id)
                 throws RemoteException

ILIAS addReference. Create new link of given object to new object. Return the new reference id

Throws:

RemoteException

deleteObject

boolean deleteObject(String sid,
                     int reference_id)
                     throws RemoteException

ILIAS deleteObject. Stores object in trash. If multiple references exist, only the reference is deleted

Throws:

RemoteException

removeFromSystemByImportId

boolean removeFromSystemByImportId(String sid,
                                   String import_id)
                                   throws RemoteException

ILIAS removeFromSystemByImportId(). Removes an object identified by its import id permanently from the system. All data will be deleted. There will be no possibility to restore it from the trash. Do not use this function for deleting roles or users. Use deleteUser() or deleteRole() instead.

Throws:

RemoteException

addUserRoleEntry

boolean addUserRoleEntry(String sid,
                         int user_id,
                         int role_id)
                         throws RemoteException

ILIAS addUserRoleEntry. Assign user to role.

Throws:

RemoteException

deleteUserRoleEntry

boolean deleteUserRoleEntry(String sid,
                            int user_id,
                            int role_id)
                            throws RemoteException

ILIAS deleteUserRoleEntry. Deassign user from role.

Throws:

RemoteException

getOperations

IlOperation[] getOperations(String sid)
                            throws RemoteException

ILIAS getOperations(): get complete set of RBAC operations.

Throws:

RemoteException

revokePermissions

boolean revokePermissions(String sid,
                          int ref_id,
                          int role_id)
                          throws RemoteException

ILIAS revokePermissions(): Revoke all permissions for a specific role on an object.

Throws:

RemoteException

grantPermissions

boolean grantPermissions(String sid,
                         int ref_id,
                         int role_id,
                         int[] operations)
                         throws RemoteException

ILIAS grantPermissions(): Grant permissions for a specific role on an object. (Substitutes existing permission settings)

Throws:

RemoteException

getLocalRoles

String getLocalRoles(String sid,
                     int ref_id)
                     throws RemoteException

ILIAS getLocalRoles(): Get all local roles assigned to an specific object.

Throws:

RemoteException

getUserRoles

String getUserRoles(String sid,
                    int user_id)
                    throws RemoteException

ILIAS getUserRoles(): Get all local roles assigned to an specific user.

Throws:

RemoteException

addRole

int[] addRole(String sid,
              int target_id,
              String obj_xml)
              throws RemoteException

ILIAS addRole(): Creates new role under given node. "target_id" is the reference id of an ILIAS ILIAS object. E.g ref_id of crs,grp. If no role folder exists, a new role folder will be created.

Throws:

RemoteException

deleteRole

boolean deleteRole(String sid,
                   int role_id)
                   throws RemoteException

ILIAS deleteRole(): Deletes an role and all user assignments. Fails if it is the last role of an user

Throws:

RemoteException

addRoleFromTemplate

int[] addRoleFromTemplate(String sid,
                          int target_id,
                          String obj_xml,
                          int role_template_id)
                          throws RemoteException

ILIAS addRole(): Creates new role under given node. "target_id" is the reference id of an ILIAS ILIAS object. E.g ref_id of crs,grp. If no role folder exists, a new role folder will be created. In addition to addRole the template permissions will be copied from the given role template

Throws:

RemoteException

getObjectTreeOperations

IlOperation[] getObjectTreeOperations(String sid,
                                      int ref_id,
                                      int user_id)
                                      throws RemoteException

ILIAS getObjectTreeOperations(): Get all granted permissions for all references of an object for a specific user. Returns array of granted operations or empty array

Throws:

RemoteException

addGroup

int addGroup(String sid,
             int target_id,
             String group_xml)
             throws RemoteException

ILIAS addGroup(): Add grop according to valid group XML

Throws:

RemoteException

groupExists

boolean groupExists(String sid,
                    String title)
                    throws RemoteException

ILIAS addGroup(): Check if group with given name exists.

Throws:

RemoteException

getGroup

String getGroup(String sid,
                int ref_id)
                throws RemoteException

ILIAS getGroup(): get xml description of grouip with given reference id.

Throws:

RemoteException

assignGroupMember

boolean assignGroupMember(String sid,
                          int group_id,
                          int user_id,
                          String type)
                          throws RemoteException

ILIAS assignGroupMember(). Assigns an user to an existing group. Type should be "Admin","Member"

Throws:

RemoteException

excludeGroupMember

boolean excludeGroupMember(String sid,
                           int group_id,
                           int user_id)
                           throws RemoteException

ILIAS excludeGroupMember(). Excludes an user from an existing group.

Throws:

RemoteException

isAssignedToGroup

int isAssignedToGroup(String sid,
                      int group_id,
                      int user_id)
                      throws RemoteException

ILIAS isAssignedToGroup(). Checks whether an user is assigned to a given group. Returns 0 => not assigned, 1 => group admin, 2 => group member

Throws:

RemoteException

sendMail

boolean sendMail(String sid,
                 String rcp_to,
                 String rcp_cc,
                 String rcp_bcc,
                 String sender,
                 String subject,
                 String message,
                 String attachments)
                 throws RemoteException

ILIAS sendMail(): Send mime mails according to xml description. Only for internal usage Syntax, parameters may change in future releases

Throws:

RemoteException

ilClone

int ilClone(String sid,
            int copy_identifier)
            throws RemoteException

ILIAS ilClone(): Only for internal usage.Syntax, parameters may change in future releases.

Throws:

RemoteException

handleECSTasks

boolean handleECSTasks(String sid)
                       throws RemoteException

ILIAS handleECSTasks(): Only for internal usage.Syntax, parameters may change in future releases.

Throws:

RemoteException

ilCloneDependencies

boolean ilCloneDependencies(String sid,
                            int copy_identifier)
                            throws RemoteException

ILIAS ilCloneDependencies(): Only for internal usage.Syntax, parameters may change in future releases.

Throws:

RemoteException

saveQuestionResult

boolean saveQuestionResult(String sid,
                           int user_id,
                           int test_id,
                           int question_id,
                           int pass,
                           String[] solution)
                           throws RemoteException

ILIAS saveQuesionResult: Typically called from an external assessment question to save the user input. DEPRECATED since ILIAS 3.9

Throws:

RemoteException

saveQuestion

boolean saveQuestion(String sid,
                     long active_id,
                     long question_id,
                     int pass,
                     String[] solution)
                     throws RemoteException

ILIAS saveQuestion: Saves the result of a question in a given test pass for the active test user. The active user is identified by the active ID, which assigns a user to a test.

Throws:

RemoteException

saveQuestionSolution

String saveQuestionSolution(String sid,
                            long active_id,
                            long question_id,
                            int pass,
                            String solution)
                            throws RemoteException

ILIAS saveQuestionSolution: Saves the result of a question in a given test pass for the active test user. The active user is identified by the active ID, which assigns a user to a test. The solution has to be an XML string which contains <values><value>VALUE</value><value>VALUE</value><points>POINTS</points>...</values> where the triplet (value,value,points) can repeat n times. The result string is either TRUE or it contains an error message.

Throws:

RemoteException

getQuestionSolution

String[] getQuestionSolution(String sid,
                             long active_id,
                             int question_id,
                             int pass)
                             throws RemoteException

ILIAS getQuestionSolution: Typically called from external assessment questions to retrieve the previous input of a user.

Throws:

RemoteException

getTestUserData

String[] getTestUserData(String sid,
                         long active_id)
                         throws RemoteException

ILIAS getTestUserData: Typically called from external assessment questions to retrieve data of the active user. The returned string array values are fullname, title, firstname, lastname, login.

Throws:

RemoteException

getPositionOfQuestion

int getPositionOfQuestion(String sid,
                          long active_id,
                          int question_id,
                          int pass)
                          throws RemoteException

ILIAS getPositionOfQuestion: Returns the position of a given question for a given user in a given test pass.

Throws:

RemoteException

getPreviousReachedPoints

double[] getPreviousReachedPoints(String sid,
                                  long active_id,
                                  int question_id,
                                  int pass)
                                  throws RemoteException

ILIAS getPreviousReachedPoints: Returns an array of reached points for the previous questions in a given test pass.

Throws:

RemoteException

getNrOfQuestionsInPass

int getNrOfQuestionsInPass(String sid,
                           long active_id,
                           int pass)
                           throws RemoteException

ILIAS getNrOfQuestionsInPass: Returns the question count for a given test user in a given pass.

Throws:

RemoteException

getStructureObjects

String getStructureObjects(String sid,
                           int ref_id)
                           throws RemoteException

ILIAS getStructureObjects: delivers structure of content objects like learning modules (chapters/pages) or glossary (terms)

Throws:

RemoteException

importUsers

String importUsers(String sid,
                   int folder_id,
                   String usr_xml,
                   int conflict_rule,
                   int send_account_mail)
                   throws RemoteException

ILIAS import users into folder id, which should be ref_id of folder or user folder (-1:System user folder, 0: checks access at user level, otherwise refid): conflict_rule: IL_FAIL_ON_CONFLICT = 1, IL_UPDATE_ON_CONFLICT = 2, IL_IGNORE_ON_CONFLICT = 3. The Return-Value is a protocol with the columns userid, login, action, message, following xmlresultset dtd. Send Account Mail = 0 deactivates sending a mail to each user, 1 activates it

Throws:

RemoteException

getRoles

String getRoles(String sid,
                String role_type,
                String id)
                throws RemoteException

ILIAS getRoles():if id equals -1, get all roles specified by type (global|local|user|user_login|template or empty), if type is empty all roles with all types are delivered, if id > -1 and role_type <> user or user_login, delivers all roles which belong to a repository object with specified ref_id, if roletype is user a numeric id is interpreted as userid, if roletype is user_login it is interpreted as login,if roletype is template all role templates will be listed

Throws:

RemoteException

getUsersForContainer

String getUsersForContainer(String sid,
                            int ref_id,
                            int attach_roles,
                            int active)
                            throws RemoteException

ILIAS getUsersForContainer(): get all users of a specific ref_id, which can be crs, group, category or user folder (value: -1). Choose if all roles of a user should be attached (1) or not (0). set active to -1 to get all, 0, to get inactive users only, 1 to get active users only

Throws:

RemoteException

getUsersForRole

String getUsersForRole(String sid,
                       int role_id,
                       int attach_roles,
                       int active)
                       throws RemoteException

ILIAS getUsersForRole(): get all users of a role with specified id, specify attach_roles to 1, to attach all role assignmnents; specify active: 1, to import active only, 0: inactive only, -1: both

Throws:

RemoteException

searchUser

String searchUser(String sid,
                  String[] key_fields,
                  String query_operator,
                  String[] key_values,
                  int attach_roles,
                  int active)
                  throws RemoteException

ILIAS searchUser(): get all users, which match a query, consisting of the keyfields, matched with values of the field values, concatenated with the logical query operator. Specify attach_roles to 1, to attach all role assignmnents; specify active: 1, to import active only, 0: inactive only, -1: both

Throws:

RemoteException

hasNewMail

boolean hasNewMail(String sid)
                   throws RemoteException

ILIAS hasNewMail(): Checks whether the current authenticated user has a new mail.

Throws:

RemoteException

getNIC

String getNIC(String sid)
              throws RemoteException

ILIAS getNIC(): DEPRECATED: use getClientInfoXML instead. was: return client information from current client as xml result set containing installation_id, installation_version, installation_url, installation_description, installation_language_default as columns

Throws:

RemoteException

getExerciseXML

String getExerciseXML(String sid,
                      int ref_id,
                      int attachment_mode)
                      throws RemoteException

ILIAS getExerciseXML(): returns xml description of exercise. Attachment mode: 0 - no file contents, 1 - plain content (base64encoded), 2 zlib + base64, 3 gzip + base64)

Throws:

RemoteException

addExercise

int addExercise(String sid,
                int target_id,
                String xml)
                throws RemoteException

ILIAS addExercise(): create exercise, put it into target (ref_id) and update exercise properties from xml (see ilias_exercise_3_8.dtd for details). Obj_id must not be set!

Throws:

RemoteException

updateExercise

boolean updateExercise(String sid,
                       int ref_id,
                       String xml)
                       throws RemoteException

ILIAS updateExercise():update existing exercise, update exercise properties from xml (see ilias_exercise_3_8.dtd for details). obj_id in xml must match according obj id of refid.!

Throws:

RemoteException

getFileXML

String getFileXML(String sid,
                  int ref_id,
                  int attachment_mode)
                  throws RemoteException

ILIAS getFileXML(): returns xml description of file. Attachment mode: 0 - no file contents, 1 - plain content (base64encoded), 2 zlib + base64, 3 gzip + base64)

Throws:

RemoteException

addFile

int addFile(String sid,
            int target_id,
            String xml)
            throws RemoteException

ILIAS addFile(): create file, put it into target (ref_id) and update file properties from xml (see ilias_file_3_8.dtd for details). Obj_id must not be set!

Throws:

RemoteException

updateFile

boolean updateFile(String sid,
                   int ref_id,
                   String xml)
                   throws RemoteException

ILIAS updateFile():update existing file, update file properties from xml (see ilias_file_3_8.dtd for details). obj_id in xml must match according obj id of refid.!

Throws:

RemoteException

getUserXML

String getUserXML(String sid,
                  int[] user_ids,
                  int attach_roles)
                  throws RemoteException

ILIAS getUserXML(): get xml records for user ids, e.g. retrieved vom members of course xml. Returns user xml dtds. ids are numeric ids of user

Throws:

RemoteException

getObjIdsByRefIds

int[] getObjIdsByRefIds(String sid,
                        int[] ref_ids)
                        throws RemoteException

ILIAS getObjIdsForRefIds: Returns a array of object ids which match the references id, given by a comma seperated string. Returns an array of ref ids, in the same order as object ids. Therefore, there might by duplicates

Throws:

RemoteException

updateGroup

boolean updateGroup(String sid,
                    int ref_id,
                    String xml)
                    throws RemoteException

ILIAS updateGroup(): update existing group using ref id and group xml (see DTD).

Throws:

RemoteException

getIMSManifestXML

String getIMSManifestXML(String sid,
                         int ref_id)
                         throws RemoteException

ILIAS getIMSManifestXML(): returns xml of ims manifest file (scorm learning module) referred by refid

Throws:

RemoteException

hasSCORMCertificate

boolean hasSCORMCertificate(String sid,
                            int ref_id,
                            int usr_id)
                            throws RemoteException

ILIAS hasSCORMCertificate(): returns true if a certficate is available for a user referred by usr_id in a SCORM learning module referred by ref_id

Throws:

RemoteException

getSCORMCompletionStatus

String getSCORMCompletionStatus(String sid,
                                int usr_id,
                                int ref_id)
                                throws RemoteException

ILIAS getSCORMCompletionStatus(): returns a completion status of a scorm module

Throws:

RemoteException

copyObject

int copyObject(String sid,
               String xml)
               throws RemoteException

ILIAS copyObject(): returns reference of copy, if copy is created directly, or the ref id of the target if copy is in progress.

Throws:

RemoteException

moveObject

boolean moveObject(String sid,
                   int ref_id,
                   int target_id)
                   throws RemoteException

ILIAS moveObject(): returns true, if object with refid could be successfully moved to target id, other it raises an error.

Throws:

RemoteException

getTestResults

String getTestResults(String sid,
                      int ref_id,
                      boolean sum_only)
                      throws RemoteException

ILIAS getTestResults(): returns XMLResultSet with sum only = true: user_id, login, firstname, lastname, matriculation, maximum points, received points sum only = false: user_id, login, firstname, lastname, matriculation, question id, question title, question points, received points

Throws:

RemoteException

getCoursesForUser

String getCoursesForUser(String sid,
                         String parameters)
                         throws RemoteException

ILIAS getTestResults(): returns XMLResultSet with columns ref_id, course xml. $parameters has to contain a column user_id and a column status. Status is a logical AND combined value of (MEMBER = 1, TUTOR = 2, ADMIN = 4, OWNER = 8) and determines which courses should be returned.

Throws:

RemoteException

getGroupsForUser

String getGroupsForUser(String sid,
                        String parameters)
                        throws RemoteException

ILIAS getTestResults(): returns XMLResultSet with columns ref_id, group xml. $parameters has to contain a column user_id and a column status. Status is a logical AND combined value of (MEMBER = 1, TUTOR = 2, OWNER = 4) and determines which groups should be returned.

Throws:

RemoteException

getPathForRefId

String getPathForRefId(String sid,
                       int ref_id)
                       throws RemoteException

ILIAS getPathForRefId(): returns XMLResultSet with columns ref_id, type and title.

Throws:

RemoteException

searchRoles

String searchRoles(String sid,
                   String key,
                   String combination,
                   String role_type)
                   throws RemoteException

ILIAS searchRoles(): returns XML following role dtd with search results for given role type and search terms.

Throws:

RemoteException

getInstallationInfoXML

String getInstallationInfoXML()
                              throws RemoteException

ILIAS getInstallationInfoXML(): returns XML following installation_info dtd

Throws:

RemoteException

getClientInfoXML

String getClientInfoXML(String clientid)
                        throws RemoteException

ILIAS getClientInfoXML(): returns XML following installation_info dtd, contains the client the data of given client id

Throws:

RemoteException

getUserIdBySid

int getUserIdBySid(String sid)
                   throws RemoteException

ILIAS getUserIdBySid(): returns an ILIAS usr_id for the given sid

Throws:

RemoteException

deleteExpiredDualOptInUserObjects

boolean deleteExpiredDualOptInUserObjects(String sid,
                                          int usr_id)
                                          throws RemoteException

ILIAS deleteExpiredDualOptInUserObjects(): Deletes expired user accounts caused by unconfirmed registration links in "dual opt in" registration method

Throws:

RemoteException