NodeClickedRef.java

/**
* OLAT - Online Learning and Training<br>
* http://www.olat.org
* <p>
* Licensed under the Apache License, Version 2.0 (the "License"); <br>
* you may not use this file except in compliance with the License.<br>
* You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing,<br>
* software distributed under the License is distributed on an "AS IS" BASIS, <br>
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
* See the License for the specific language governing permissions and <br>
* limitations under the License.
* <p>
* Copyright (c) since 2004 at Multimedia- & E-Learning Services (MELS),<br>
* University of Zurich, Switzerland.
* <hr>
* <a href="http://www.openolat.org">
* OpenOLAT - Online Learning and Training</a><br>
* This file has been modified by the OpenOLAT community. Changes are licensed
* under the Apache 2.0 license as the original file.
*/

package org.olat.course.run.navigation;

import java.util.List;

import org.olat.core.gui.components.tree.TreeModel;
import org.olat.core.gui.control.Controller;
import org.olat.course.nodes.CourseNode;

/**
 * Description: <br>
 * TODO: Felix Jost Class Description for NodeClickedResult
 * <P>
 * useful usage of this class: <br>
 * 1. handled by subtreelistener? yes? break : continue 2. check if visible ->
 * no? genericNonVisMessage : continue (done internally here: check if
 * accessible -> no? noAccessExplanation of calledCourseNode : continue) 4. get
 * new treemodel, new selectedNodeId, new Controller, and new calledCourseNode
 * to build up the gui
 * 
 * Initial Date: 19.01.2005 <br>
 * @author Felix Jost
 */
public class NodeClickedRef {
	// the new treemodel that results from the user's click
	private TreeModel treeModel;

	// whether the treenode clicked corresponds to a coursenode with visiblity
	// condition evaluated to true
	private boolean visible;

	// the node id of the treemodel given here that is now selected. if null, then
	// no node is selected
	// (which can only be the case if even the root course node is not visible)
	private String selectedNodeId;
	
	private List<String> openNodeIds;

	// the coursenode which was called when clicking the treenode (used only to
	// update scoring on that coursenode).
	// can be only null when selectedNodeId is null.
	private CourseNode calledCourseNode;

	// the resulting controller, the subtreelistener, and the subtree: fetched
	// from the coursenode
	private NodeRunConstructionResult nodeConstructionResult;
	
	
	private boolean handledBySubTreeModelListener;

	/**
	 * @param treeModel
	 * @param visible
	 * @param selectedNodeId
	 * @param calledCourseNode
	 * @param nodeConstructionResult null means that no new node controller has
	 *          been created, but is was handled by the subtreemodellistener
	 */
	NodeClickedRef(TreeModel treeModel, boolean visible, String selectedNodeId, List<String> openNodeIds, CourseNode calledCourseNode,
			NodeRunConstructionResult nodeConstructionResult, boolean handledBySubTreeModelListener) {
		this.treeModel = treeModel;
		this.visible = visible;
		this.selectedNodeId = selectedNodeId;
		this.openNodeIds = openNodeIds;
		this.calledCourseNode = calledCourseNode;
		this.nodeConstructionResult = nodeConstructionResult;
		this.handledBySubTreeModelListener = handledBySubTreeModelListener;
	}

	/**
	 * @return if handled by the sublistener
	 */
	public boolean isHandledBySubTreeModelListener() {
		return handledBySubTreeModelListener;
	}

	/**
	 * @return the coursenode that was called
	 */
	public CourseNode getCalledCourseNode() {
		return calledCourseNode;
	}

	/**
	 * @return the selected node id
	 */
	public String getSelectedNodeId() {
		if(nodeConstructionResult == null) {
			return selectedNodeId;
		} else {
			String subNodeId = nodeConstructionResult.getSelectedTreeNodeId();
			// if subNodeId != null (e.g. a inner node of a content-packaging -> select this node
			if (subNodeId != null) {
				return subNodeId;
			} else {
				return selectedNodeId;
			}
		}
	}
	
	public List<String> getOpenNodeIds() {
		return openNodeIds;
	}

	/**
	 * @return the treemodel
	 */
	public TreeModel getTreeModel() {
		return treeModel;
	}

	/**
	 * @return true if visible
	 */
	public boolean isVisible() {
		return visible;
	}

	/**
	 * @return the run controller or null
	 */
	public Controller getRunController() {
		if(calledCourseNode == null || nodeConstructionResult == null) return null;
		return nodeConstructionResult.getRunController();
	}
}