com.deltalearn.rte.webservice
Interface ICoursesService

All Known Subinterfaces:

IDeltalearnService

public interface ICoursesService

Deltalearn services related to courses.

Functionalities provided:

• Imports and removes courses.
• Obtains basic and structural information about imported courses.
• Registers users into courses, unregisters them, and lists registrarions.
• Obtains the status of a user in a course.

Version:

0.1

Method Summary

ICourseInfo	getCourseInfo(java.lang.String courseId) Returns basic information about a course.
ICourseInfo[]	getCourseInfos() Returns basic information about all the imported courses.
ICourseUserStatus[]	getCourseStatus(java.lang.String userId) Returns the status of the all the courses in which a user is registered.
ICourseStructure	getCourseStructure(java.lang.String courseId) Returns the hierarchical structure of a course.
ICourseInfo[]	getCoursesUserIsNotRegisteredIn(java.lang.String userId) Returns basic information about the courses in which a user is not registered.
ICourseInfo[]	getCoursesUserIsRegisteredIn(java.lang.String userId) Returns basic information about the courses in which a user is registered.
ICourseUserStatus	getCourseUserStatus(java.lang.String userId, java.lang.String courseId) Returns the status of the course in which a user is registered.
int	getCourseVersion(java.lang.String courseId) Returns the version of a course.
IImportCourseResult	importCourse(byte[] zipFile) Imports a course, given a byte array representing a zip containing the course, as defined by the SCORM standard.
boolean	isUserRegisteredToCourse(java.lang.String userId, java.lang.String courseId) Determines if a user is registered in a course.
void	registerUserIntoCourse(java.lang.String userId, java.lang.String courseId) Registers a user into a course.
boolean	removeCourse(java.lang.String courseId) Removes a course previously imported.
void	unregisterUserFromCourse(java.lang.String userId, java.lang.String courseId) Unregisters a user from a course.

Method Detail

importCourse

IImportCourseResult importCourse(byte[] zipFile)

Imports a course, given a byte array representing a zip containing the course, as defined by the SCORM standard. This method does not validate the correctness of the manifest.

Parameters:

zipFile - byte array of the zip file

Returns:

the result of importing the course

removeCourse

boolean removeCourse(java.lang.String courseId)

Removes a course previously imported.

Parameters:

courseId - the id of a course

Returns:

true is the course was removed, false otherwise (the course didn't exist previously)

See Also:

importCourse(byte[])

getCourseStructure

ICourseStructure getCourseStructure(java.lang.String courseId)

Returns the hierarchical structure of a course.

Parameters:

courseId - the id of a course

Returns:

the structure of the course, or null if the course doesn't exist

getCourseInfos

ICourseInfo[] getCourseInfos()

Returns basic information about all the imported courses.

Returns:

the basic informations about all the imported courses

getCourseInfo

ICourseInfo getCourseInfo(java.lang.String courseId)

Returns basic information about a course.

Parameters:

courseId - the id of the course

Returns:

basic information about a course

getCourseVersion

int getCourseVersion(java.lang.String courseId)

Returns the version of a course. Possible results are 12, 2004 or 0, if the course doesn't exist.

Parameters:

courseId - the id of a course

Returns:

the version of a course. Can be 12, 2004 or 0, if the course doesn't exist

registerUserIntoCourse

void registerUserIntoCourse(java.lang.String userId,
                            java.lang.String courseId)

Registers a user into a course.

Parameters:

userId - the id of a user

courseId - the id of a course

unregisterUserFromCourse

void unregisterUserFromCourse(java.lang.String userId,
                              java.lang.String courseId)

Unregisters a user from a course.

Parameters:

userId - the id of a user

courseId - the id of a course

isUserRegisteredToCourse

boolean isUserRegisteredToCourse(java.lang.String userId,
                                 java.lang.String courseId)

Determines if a user is registered in a course.

Parameters:

userId - the id of a user

courseId - the id of a course

Returns:

true if the user is registered in the course, false otherwise

getCoursesUserIsRegisteredIn

ICourseInfo[] getCoursesUserIsRegisteredIn(java.lang.String userId)

Returns basic information about the courses in which a user is registered.

Parameters:

userId - the id of a user

Returns:

basic information about the courses in which a user is registered

getCoursesUserIsNotRegisteredIn

ICourseInfo[] getCoursesUserIsNotRegisteredIn(java.lang.String userId)

Returns basic information about the courses in which a user is not registered.

Parameters:

userId - the id of a user

Returns:

basic information about the courses in which a user is not registered

getCourseUserStatus

ICourseUserStatus getCourseUserStatus(java.lang.String userId,
                                      java.lang.String courseId)

Returns the status of the course in which a user is registered.

Parameters:

userId - the id of a user

courseId - the id of a user

Returns:

the status of the course, or null if the user is not registered in the course

getCourseStatus

ICourseUserStatus[] getCourseStatus(java.lang.String userId)

Returns the status of the all the courses in which a user is registered.

Parameters:

userId - the id of a user

Returns:

the status of all the courses