org.olat.course
Interface ICourse

All Superinterfaces:

OLATResourceable

All Known Implementing Classes:

PersistingCourseImpl

public interface ICourse
extends OLATResourceable

Description:
Interface of the OLAT course. The course has a course environment and a run structure and some other fields.

Initial Date: 2004/10/11 13:55:48

Author:

Felix Jost

Field Summary

static java.lang.String

EXPORTED_DATA_FOLDERNAME Name of folder within course root directory where nodes export their data.

Method Summary

void	exportToFilesystem(java.io.File exportDirecotry) Export course to file system.
OlatRootFolderImpl	getCourseBaseContainer() Return the container to files for this course.
CourseEnvironment	getCourseEnvironment()
VFSContainer	getCourseFolderContainer() Return the container to the coursefolder of this course.
java.lang.String	getCourseTitle()
CourseEditorTreeModel	getEditorTreeModel()
Structure	getRunStructure()
boolean	hasAssessableNodes()

Methods inherited from interface org.olat.core.id.OLATResourceable

getResourceableId, getResourceableTypeName

Field Detail

EXPORTED_DATA_FOLDERNAME

static final java.lang.String EXPORTED_DATA_FOLDERNAME

Name of folder within course root directory where nodes export their data.

See Also:

Constant Field Values

Method Detail

getRunStructure

Structure getRunStructure()

Returns:

The course run structure

getEditorTreeModel

CourseEditorTreeModel getEditorTreeModel()

Returns:

The course editor tree model for this course

exportToFilesystem

void exportToFilesystem(java.io.File exportDirecotry)

Export course to file system.

Parameters:

exportDirecotry - The directory to export files to.

getCourseBaseContainer

OlatRootFolderImpl getCourseBaseContainer()

Return the container to files for this course. (E.g. "/course/123/")

Returns:

the container to files for this course

getCourseFolderContainer

VFSContainer getCourseFolderContainer()

Return the container to the coursefolder of this course. (E.g. "COURSEBASEPATH/coursefolder/")

Returns:

the container to the coursefolder of this course

getCourseTitle

java.lang.String getCourseTitle()

Returns:

The course title. This is the display name of the course repository entry or the short title of the course run structure root node if the repository entry has not been created yet

getCourseEnvironment

CourseEnvironment getCourseEnvironment()

Returns:

The course environment of this course

hasAssessableNodes

boolean hasAssessableNodes()

Returns:

true: if the structure has assessable nodes or structure course nodes (subtype of assessable node), which 'hasPassedConfigured' or 'hasScoreConfigured' is true