com.tle.web.entity.services
Interface SoapCourseService
Declaration: public interface SoapCourseService

 

The WSDL file for this service is available at http://INSTITUTION_URL/services/calcourses.service?wsdl (for compatibility reasons)

 

 

Methods Summary
abstract void addCourse(java.lang.String courseXml)
     Add a course.
abstract void archiveCourse(java.lang.String courseCode)
     Archives a course so that is not selectable in the web-ui (can still be edited in the Administration console)
abstract void bulkImport(java.lang.String csvText)
     Upload many courses at once using a CSV file.
abstract void delete(java.lang.String courseCode)
     Removes a course from the database.
abstract void editCourse(java.lang.String courseXml)
    
abstract java.lang.String[] enumerateCourseCodes()
    
abstract java.lang.String getCourse(java.lang.String courseCode)
     Get the XML for a course.
abstract void unarchiveCourse(java.lang.String courseCode)
     Un-archives a course so that is selectable in the web-ui

 

 

 

 

getCourse

 

public abstract java.lang.String getCourse( java.lang.String courseCode)

 

Get the XML for a course.

 

Parameters:
courseCode-
The Code of the course.
Returns:
The XStreamed XML of the CourseInfo.

 

 

 

addCourse

 

public abstract void addCourse( java.lang.String courseXml)

 

Add a course.

 

Parameters:
courseXml-
The XStreamed XML of the CourseInfo. For an example of the XML format, use getCourse

 

 

 

editCourse

 

public abstract void editCourse( java.lang.String courseXml)

 

Parameters:
courseXml-
The edited course XML in XStream format. Use getCourse to get an existing course's XML

 

 

 

bulkImport

 

public abstract void bulkImport( java.lang.String csvText)

 

Upload many courses at once using a CSV file.

 

Parameters:
csvText-
The contents of a CSV file in the format:
"Name" "Description" "Code" "Citation" "Start" "End" "Students" "Type" "DepartmentName"
Course1 Course1 Description C001 Harvard 31/01/2009 20/12/2009 100 i My Deparment

Note:
  • Type can be i (internal), e (external), s (staff)
  • Dates must be in format dd/MM/yyyy

 

 

 

enumerateCourseCodes

 

public abstract java.lang.String[] enumerateCourseCodes( )

 

Returns:
A list of course Codes

 

 

 

delete

 

public abstract void delete( java.lang.String courseCode)

 

Removes a course from the database. Note that the course cannot be reference anywhere else in the system. (E.g. by copyright activations or hierarchy topics)

 

Parameters:
courseCode-
The Code of the course to delete

 

 

 

archiveCourse

 

public abstract void archiveCourse( java.lang.String courseCode)

 

Archives a course so that is not selectable in the web-ui (can still be edited in the Administration console)

 

Parameters:
courseCode-
The Code of the course to archive

 

 

 

unarchiveCourse

 

public abstract void unarchiveCourse( java.lang.String courseCode)

 

Un-archives a course so that is selectable in the web-ui

 

Parameters:
courseCode-
The Code of the course to un-archive