org.olat.course.nodes
Class DialogCourseNode

java.lang.Object
  org.olat.core.util.nodes.GenericNode
      org.olat.course.nodes.GenericCourseNode
          org.olat.course.nodes.AbstractAccessableCourseNode
              org.olat.course.nodes.DialogCourseNode

All Implemented Interfaces:

java.io.Serializable, ShortName, INode, CourseNode

public class DialogCourseNode
extends AbstractAccessableCourseNode

Description:
TODO: guido Class Description for DialogCourseNode

Initial Date: 02.11.2005

Author:

Guido Schnider

See Also:

Serialized Form

Field Summary

static java.lang.String

TYPE

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

DISPLAY_OPTS_CONTENT, DISPLAY_OPTS_TITLE_CONTENT, DISPLAY_OPTS_TITLE_DESCRIPTION_CONTENT

Constructor Summary

DialogCourseNode()

Method Summary

void	archiveNodeData(java.util.Locale locale, ICourse course, java.io.File exportDirectory, java.lang.String charset) Generic interface implementation.
void	cleanupOnDelete(ICourse course) life cycle of node data e.g properties stuff should be deleted if node gets deleted life cycle: create - delete - migrate
TabbableController	createEditController(UserRequest ureq, WindowControl wControl, ICourse course, UserCourseEnvironment euce) 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
void	doArchiveElement(DialogElement element, java.io.File exportDirectory) Archive a single dialog element with files and forum
void	exportNode(java.io.File exportDirectory, ICourse course) Export all node user data to the given directory.
Condition	getPreConditionModerator()
Condition	getPreConditionPoster()
Condition	getPreConditionReader()
RepositoryEntry	getReferencedRepositoryEntry() used by the publish process to ensure the reference counters for a repository entry are correct.
Controller	importNode(java.io.File importDirectory, ICourse course, boolean unattendedImport, UserRequest ureq, WindowControl wControl) Import a course node's data.
java.lang.String	informOnDelete(java.util.Locale locale, ICourse course) Generic interface implementation.
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	setPreConditionModerator(Condition preConditionMod)
void	setPreConditionPoster(Condition preConditionPoster)
void	setPreConditionReader(Condition preConditionReader)
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

createInstanceForCopy, createPeekViewRunController, createPreviewController, eval, explainThisDuringPublish, getDisplayOption, getDisplayOption, getLearningObjectives, getLongTitle, getModuleConfiguration, getNoAccessExplanation, getPreConditionVisibility, getShortName, getShortTitle, getType, 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

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

DialogCourseNode

public DialogCourseNode()

Method Detail

createEditController

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

Description copied from interface: CourseNode

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

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

Returns:

A tabbable node edit controller

See Also:

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

createNodeRunConstructionResult

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

Description copied from interface: CourseNode

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:

GenericCourseNode.createNodeRunConstructionResult(org.olat.core.gui.UserRequest, org.olat.core.gui.control.WindowControl, org.olat.course.run.userview.UserCourseEnvironment, org.olat.course.run.userview.NodeEvaluation, java.lang.String)

isConfigValid

public StatusDescription[] isConfigValid(CourseEditorEnv cev)

Description copied from class: GenericCourseNode

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:

GenericCourseNode.isConfigValid(org.olat.course.editor.CourseEditorEnv)

getReferencedRepositoryEntry

public RepositoryEntry getReferencedRepositoryEntry()

Description copied from interface: CourseNode

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

See Also:

CourseNode.getReferencedRepositoryEntry()

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.

See Also:

CourseNode.needsReferenceToARepositoryEntry()

isConfigValid

public StatusDescription isConfigValid()

Returns:

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

See Also:

CourseNode.isConfigValid()

updateModuleConfigDefaults

public void updateModuleConfigDefaults(boolean isNewNode)

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

informOnDelete

public java.lang.String informOnDelete(java.util.Locale locale,
                                       ICourse course)

Description copied from class: GenericCourseNode

Generic interface implementation. May be overriden by specific node's implementation.

Specified by:

informOnDelete in interface CourseNode

Overrides:

informOnDelete in class GenericCourseNode

course - The course

Returns:

The dialogue message if any data will be deleted in the next step

See Also:

org.olat.course.nodes.CourseNode#informOnDelete(org.olat.core.gui.UserRequest, org.olat.course.ICourse)

cleanupOnDelete

public void cleanupOnDelete(ICourse course)

life cycle of node data e.g properties stuff should be deleted if node gets deleted life cycle: create - delete - migrate

Specified by:

cleanupOnDelete in interface CourseNode

Overrides:

cleanupOnDelete in class GenericCourseNode

Parameters:

course - The course

See Also:

CourseNode.cleanupOnDelete(org.olat.course.ICourse)

archiveNodeData

public void archiveNodeData(java.util.Locale locale,
                            ICourse course,
                            java.io.File exportDirectory,
                            java.lang.String charset)

Generic interface implementation. May be overriden by specific node's implementation.

Specified by:

archiveNodeData in interface CourseNode

Overrides:

archiveNodeData in class GenericCourseNode

Parameters:

locale - The users locale

course - The course

exportDirectory - The directory where the exported files should be put. This directory must exist prior to calling this method.

See Also:

org.olat.course.nodes.CourseNode#archiveNodeData(java.util.Locale, org.olat.course.ICourse, java.io.File)

doArchiveElement

public void doArchiveElement(DialogElement element,
                             java.io.File exportDirectory)

Archive a single dialog element with files and forum

Parameters:

element -

exportDirectory -

exportNode

public void exportNode(java.io.File exportDirectory,
                       ICourse course)

Description copied from interface: CourseNode

Export all node user data to the given directory. This might be one file or multiple files depending on what data is available. The archived data is intendet to be imported again if the course this node is attached to gets imported.

Specified by:

exportNode in interface CourseNode

Overrides:

exportNode in class GenericCourseNode

Parameters:

exportDirectory - The directory where the exported files should be put. This directory must exist prior to calling this method.

See Also:

CourseNode.exportNode(java.io.File, org.olat.course.ICourse)

importNode

public Controller importNode(java.io.File importDirectory,
                             ICourse course,
                             boolean unattendedImport,
                             UserRequest ureq,
                             WindowControl wControl)

Description copied from interface: CourseNode

Import a course node's data. The import directory is the root of the directory with all the data that the node has written previousely during the export. The node can provide a Controller if any user intervention is needed. The controller should send a Event.DONE_EVENT after finishing the user driven import. If no user driven import is necessary, just return null right away after finishing all importing tasks.

Specified by:

importNode in interface CourseNode

Overrides:

importNode in class GenericCourseNode

Returns:

Controller for user driven import, or null after all import tasks have finished.

See Also:

org.olat.course.nodes.CourseNode#importNode(java.io.File, org.olat.course.ICourse, org.olat.core.gui.UserRequest, org.olat.core.gui.control.WindowControl)

getPreConditionModerator

public Condition getPreConditionModerator()

Returns:

Returns the preConditionModerator.

setPreConditionModerator

public void setPreConditionModerator(Condition preConditionMod)

Parameters:

preConditionModerator - The preConditionModerator to set.

getPreConditionPoster

public Condition getPreConditionPoster()

Returns:

Returns the preConditionPoster.

setPreConditionPoster

public void setPreConditionPoster(Condition preConditionPoster)

Parameters:

preConditionPoster - The preConditionPoster to set.

getPreConditionReader

public Condition getPreConditionReader()

Returns:

Returns the preConditionReader.

setPreConditionReader

public void setPreConditionReader(Condition preConditionReader)

Parameters:

preConditionReader - The preConditionReader to set.