TOCElement.java

/**
 * <a href="http://www.openolat.org">
 * OpenOLAT - Online Learning and Training</a><br>
 * <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 the
 * <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache homepage</a>
 * <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>
 * Initial code contributed and copyrighted by<br>
 * frentix GmbH, http://www.frentix.com
 * <p>
 */
package org.olat.portfolio.ui.structel.view;

import java.util.List;

import org.olat.core.gui.components.link.Link;

/**
 * Description:<br>
 * data container for a TOC element
 * 
 * <P>
 * Initial Date:  26.10.2010 <br>
 * @author Roman Haag, roman.haag@frentix.com, http://www.frentix.com
 */
public class TOCElement {

	private final int level;
	private final String type;
	private final Link iconLink;
	private final Link titleLink;
	private final Link userCommentLink;
	private final List<TOCElement> childs;
		
	public TOCElement(int level, String type, Link titleLink, Link iconLink, Link userCommentLink, List<TOCElement> childs){
		this.level = level;
		this.type = type;
		this.iconLink = iconLink;
		this.titleLink = titleLink;
		this.userCommentLink = userCommentLink;
		this.childs = childs;
	}
	
	/**
	 * @return Returns the level.
	 */
	public int getLevel() {
		return level;
	}
	/**
	 * @return Returns the type.
	 */
	public String getType() {
		return type;
	}
	/**
	 * @return Returns the link with an icon.
	 */
	public Link getIconLink() {
		return iconLink;
	}
	
	/**
	 * @return Returns the link with the title
	 */
	public Link getTitleLink() {
		return titleLink;
	}
	
	/**
	 * @return Return the link for user comments
	 */
	public Link getCommentLink() {
		return userCommentLink;
	}
	
	public String getCommentLinkComponentName() {
		return userCommentLink == null ? "comment-null" : userCommentLink.getComponentName();
	}

	/**
	 * @return Returns the child.
	 */
	public List<TOCElement> getChilds() {
		return childs;
	}
}