de.bps.course.nodes
Class LLCourseNode

java.lang.Object
  org.olat.core.util.nodes.GenericNode
      org.olat.course.nodes.GenericCourseNode
          org.olat.course.nodes.AbstractAccessableCourseNode
              de.bps.course.nodes.LLCourseNode

All Implemented Interfaces:

java.io.Serializable, ShortName, INode, CourseNode

public class LLCourseNode
extends AbstractAccessableCourseNode

Description:
Link list course node.

Initial Date: 05.11.2008

Author:

Marcel Karras (toka@freebits.de)

See Also:

Serialized Form

Field Summary

static java.lang.String	CONF_COURSE_ID
static java.lang.String	CONF_COURSE_NODE_ID
static java.lang.String	CONF_LINKLIST

Fields inherited from interface org.olat.course.nodes.CourseNode

DISPLAY_OPTS_CONTENT, DISPLAY_OPTS_TITLE_CONTENT, DISPLAY_OPTS_TITLE_DESCRIPTION_CONTENT

Constructor Summary

LLCourseNode()
Create default link list course node.

Method Summary

TabbableController	createEditController(UserRequest ureq, WindowControl wControl, ICourse course, UserCourseEnvironment userCourseEnv) Create a node edit controller for this node to configure node specific features
NodeRunConstructionResult	createNodeRunConstructionResult(UserRequest ureq, WindowControl wControl, UserCourseEnvironment userCourseEnv, NodeEvaluation ne, java.lang.String nodecmd) Create a course run controller for this node
Controller	createPeekViewRunController(UserRequest ureq, WindowControl wControl, UserCourseEnvironment userCourseEnv, NodeEvaluation ne) Default implementation of the peekview controller that returns NULL: no node specific peekview information should be shown Override this method with a specific implementation if you have something interesting to show in the peekview
Controller	createPreviewController(UserRequest ureq, WindowControl wControl, UserCourseEnvironment userCourseEnv, NodeEvaluation ne) default implementation of the previewController
RepositoryEntry	getReferencedRepositoryEntry() used by the publish process to ensure the reference counters for a repository entry are correct.
StatusDescription	isConfigValid()
StatusDescription[]	isConfigValid(CourseEditorEnv cev) must be implemented in the concrete subclasses as a translator is needed for the errormessages which comes with evaluating condition expressions
boolean	needsReferenceToARepositoryEntry()
void	updateModuleConfigDefaults(boolean isNewNode) Update the module configuration to have all mandatory configuration flags set to usefull default values

Methods inherited from class org.olat.course.nodes.AbstractAccessableCourseNode

createInstanceForCopy, getConditionExpressions, getPreConditionAccess, setPreConditionAccess

Methods inherited from class org.olat.course.nodes.GenericCourseNode

archiveNodeData, cleanupOnDelete, createInstanceForCopy, eval, explainThisDuringPublish, exportNode, getDisplayOption, getDisplayOption, getLearningObjectives, getLongTitle, getModuleConfiguration, getNoAccessExplanation, getPreConditionVisibility, getShortName, getShortTitle, getType, importNode, informOnDelete, setDisplayOption, setLearningObjectives, setLongTitle, setModuleConfiguration, setNoAccessExplanation, setPreConditionVisibility, setShortTitle, setType, toString

Methods inherited from class org.olat.core.util.nodes.GenericNode

addChild, findRoot, getChildAt, getChildCount, getIdent, getParent, getPosition, insert, remove, removeAllChildren, removeFromParent, setIdent, setParent

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.olat.course.nodes.CourseNode

setIdent

Methods inherited from interface org.olat.core.util.nodes.INode

addChild, getChildAt, getChildCount, getIdent, getParent, getPosition, insert, remove, removeAllChildren, removeFromParent, setParent

Field Detail

CONF_COURSE_ID

public static final java.lang.String CONF_COURSE_ID

See Also:

Constant Field Values

CONF_COURSE_NODE_ID

public static final java.lang.String CONF_COURSE_NODE_ID

See Also:

Constant Field Values

CONF_LINKLIST

public static final java.lang.String CONF_LINKLIST

See Also:

Constant Field Values

Constructor Detail

LLCourseNode

public LLCourseNode()

Create default link list course node.

Method Detail

updateModuleConfigDefaults

public void updateModuleConfigDefaults(boolean isNewNode)

Description copied from class: GenericCourseNode

Update the module configuration to have all mandatory configuration flags set to usefull default values

Specified by:

updateModuleConfigDefaults in interface CourseNode

Overrides:

updateModuleConfigDefaults in class GenericCourseNode

Parameters:

isNewNode - true: an initial configuration is set; false: upgrading from previous node configuration version, set default to maintain previous behaviour This is the workflow: On every click on a entry of the navigation tree, this method will be called to ensure a valid configration of the depending module. This is only done in RAM. If the user clicks on that node in course editor and publishes the course after that, then the updated config will be persisted to disk. Otherwise everything what is done here has to be done once at every course start.

createEditController

public TabbableController createEditController(UserRequest ureq,
                                               WindowControl wControl,
                                               ICourse course,
                                               UserCourseEnvironment userCourseEnv)

Create a node edit controller for this node to configure node specific features

Specified by:

createEditController in interface CourseNode

Specified by:

createEditController in class AbstractAccessableCourseNode

Parameters:

ureq - The user request

wControl - The current window controller

course - The course

userCourseEnv - the editor user course environment provides syntax/semantic check methods for conditions

Returns:

A tabbable node edit controller

See Also:

org.olat.course.nodes.CourseNode#createEditController(org.olat.core.gui.UserRequest, org.olat.core.gui.control.WindowControl, org.olat.course.ICourse)

createNodeRunConstructionResult

public NodeRunConstructionResult createNodeRunConstructionResult(UserRequest ureq,
                                                                 WindowControl wControl,
                                                                 UserCourseEnvironment userCourseEnv,
                                                                 NodeEvaluation ne,
                                                                 java.lang.String nodecmd)

Create a course run controller for this node

Specified by:

createNodeRunConstructionResult in interface CourseNode

Specified by:

createNodeRunConstructionResult in class AbstractAccessableCourseNode

Parameters:

ureq - The user request

wControl - The current window controller

userCourseEnv - The course environment

ne - The node evaluation

Returns:

The node run controller ATTENTION: udpateModuleConfigDefaults(false) should be called inside from the courseNode.createNodeRunConstructionResult(ureq, bwControl, userCourseEnv, nodeEval, nodecmd) to set the course node specific configuration default values!

See Also:

org.olat.course.nodes.CourseNode#createNodeRunConstructionResult(org.olat.core.gui.UserRequest, org.olat.core.gui.control.WindowControl, org.olat.course.run.userview.UserCourseEnvironment, org.olat.course.run.userview.NodeEvaluation)

createPeekViewRunController

public Controller createPeekViewRunController(UserRequest ureq,
                                              WindowControl wControl,
                                              UserCourseEnvironment userCourseEnv,
                                              NodeEvaluation ne)

Description copied from class: GenericCourseNode

Default implementation of the peekview controller that returns NULL: no node specific peekview information should be shown
Override this method with a specific implementation if you have something interesting to show in the peekview

Specified by:

createPeekViewRunController in interface CourseNode

Overrides:

createPeekViewRunController in class GenericCourseNode

Returns:

See Also:

GenericCourseNode.createPeekViewRunController(org.olat.core.gui.UserRequest, org.olat.core.gui.control.WindowControl, org.olat.course.run.userview.UserCourseEnvironment, org.olat.course.run.userview.NodeEvaluation)

createPreviewController

public Controller createPreviewController(UserRequest ureq,
                                          WindowControl wControl,
                                          UserCourseEnvironment userCourseEnv,
                                          NodeEvaluation ne)

Description copied from class: GenericCourseNode

default implementation of the previewController

Specified by:

createPreviewController in interface CourseNode

Overrides:

createPreviewController in class GenericCourseNode

Returns:

Controller

See Also:

GenericCourseNode.createPreviewController(org.olat.core.gui.UserRequest, org.olat.core.gui.control.WindowControl, org.olat.course.run.userview.UserCourseEnvironment, org.olat.course.run.userview.NodeEvaluation)

isConfigValid

public StatusDescription[] isConfigValid(CourseEditorEnv cev)

must be implemented in the concrete subclasses as a translator is needed for the errormessages which comes with evaluating condition expressions

Specified by:

isConfigValid in interface CourseNode

Specified by:

isConfigValid in class GenericCourseNode

Returns:

true if the course node configuration is valid for itself and also within the specified course environment.

See Also:

org.olat.course.nodes.CourseNode#isConfigValid(org.olat.course.run.userview.UserCourseEnvironment)

getReferencedRepositoryEntry

public RepositoryEntry getReferencedRepositoryEntry()

used by the publish process to ensure the reference counters for a repository entry are correct. (you can only delete Repositoryentries if there are no references to it) returns exception when called even !needsReferenceToARespositoryEntry return the referenced RepositoryEntry if it can be found return null if the referenced RepositoryEntry could not be found

Returns:

the RepositoryEntry (if it still exists in the repository) which is referenced in this course node if there is a reference, or null otherwise

isConfigValid

public StatusDescription isConfigValid()

Returns:

true if the course node configuration is correct without the course context.

See Also:

for a config validation method taking the course environment into account.

needsReferenceToARepositoryEntry

public boolean needsReferenceToARepositoryEntry()

Returns:

true if this node type potentially has a repository entry reference, false otherwhise. Attention: this method does not test if ther is actually such a reference. Use getReferencedRepository() to get this information.