ILIASSoapWebserviceBindingStub (ActiveMath API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.activemath.webapp.base.external.ilias
Class ILIASSoapWebserviceBindingStub

java.lang.Object
  org.apache.axis.client.Stub
      org.activemath.webapp.base.external.ilias.ILIASSoapWebserviceBindingStub

All Implemented Interfaces:: Remote, javax.xml.rpc.Stub, ILIASSoapWebservicePortType

public class ILIASSoapWebserviceBindingStub
extends org.apache.axis.client.Stub
implements ILIASSoapWebservicePortType
extends org.apache.axis.client.Stub
implements ILIASSoapWebservicePortType

Field Summary

Fields inherited from class org.apache.axis.client.Stub
`_call, cachedEndpoint, cachedPassword, cachedPortName, cachedProperties, cachedTimeout, cachedUsername, maintainSession, maintainSessionSet, service`

Fields inherited from interface javax.xml.rpc.Stub
`ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY`

Constructor Summary
`ILIASSoapWebserviceBindingStub()`
`ILIASSoapWebserviceBindingStub(javax.xml.rpc.Service service)`
`ILIASSoapWebserviceBindingStub(URL endpointURL, javax.xml.rpc.Service service)`

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.
`protected org.apache.axis.client.Call`	`createCall()`
`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().

Methods inherited from class org.apache.axis.client.Stub
`_createCall, _getCall, _getProperty, _getPropertyNames, _getService, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, firstCall, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeader, getResponseHeaders, getResponseHeaders, getTimeout, getUsername, removeProperty, setAttachments, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setRequestHeaders, setTimeout, setUsername`

Methods inherited from class org.apache.axis.client.Stub

_createCall, _getCall, _getProperty, _getPropertyNames, _getService, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, firstCall, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeader, getResponseHeaders, getResponseHeaders, getTimeout, getUsername, removeProperty, setAttachments, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setRequestHeaders, setTimeout, setUsername

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

ILIASSoapWebserviceBindingStub

public ILIASSoapWebserviceBindingStub()
                               throws org.apache.axis.AxisFault

Throws:: org.apache.axis.AxisFault

ILIASSoapWebserviceBindingStub

public ILIASSoapWebserviceBindingStub(URL endpointURL,
                                      javax.xml.rpc.Service service)
                               throws org.apache.axis.AxisFault

Throws:: org.apache.axis.AxisFault

ILIASSoapWebserviceBindingStub

public ILIASSoapWebserviceBindingStub(javax.xml.rpc.Service service)
                               throws org.apache.axis.AxisFault

Throws:: org.apache.axis.AxisFault

Method Detail

createCall

protected org.apache.axis.client.Call createCall()
                                          throws RemoteException

Throws:: RemoteException