xdev.ui.ganttchart.UpdateableGanttEntry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of csapi Show documentation
XDEV Component Suite
There is a newer version: 6.0.2
package xdev.ui.ganttchart;

/*-
 * #%L
 * XDEV BI Suite
 * %%
 * Copyright (C) 2011 - 2021 XDEV Software
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */


import javax.annotation.processing.Completion;

import com.jidesoft.gantt.GanttEntry;
import com.jidesoft.range.Range;


/**
 * Extension layer for {@link GanttEntry} to gain the ability to update the
 * entries values.
 * 
 * 
 * 
 * @param 
 *            the gantt data type, for example Date or
 *            Integer. Has to extend {@link Comparable} for
 *            validation purpose.
 *            
 *            Used for entry scaling via {@link GanttEntry#getRange()}
 *            
 * 
 * @author XDEV Software jwill
 * @since 4.0
 */
public interface UpdateableGanttEntry extends GanttEntry
{
	
	/**
	 * 
	 * sets a unique identifier.
	 * 
	 * @param id
	 *            the id to set.
	 * 
	 */
	public void setId(Object id);
	
	
	/**
	 * 
	 * @return a unique identifier.
	 */
	public Object getId();
	
	
	/**
	 * Sets the {@link GanttEntry}s root Entry id.
	 * 
	 * Used for hierarchical tree structure.
	 * 
	 * 
	 * @param root
	 *            the root Entry id
	 */
	public void setRoot(Object root);
	
	
	/**
	 * Returns the {@link GanttEntry}s root Entry id.
	 * 
	 * Used for hierarchical tree structure.
	 * 
	 * 
	 * @return {@link GanttEntry}s root entry.
	 */
	public Object getRoot();
	
	
	/**
	 * Sets the internal {@link GanttEntry} description.
	 * 
	 * @param name
	 *            the description value to set.
	 */
	public void setName(String name);
	
	
	/**
	 * Sets the internal {@link GanttEntry} {@link Completion}.
	 * 
	 * Can be used to create completion independencies
	 * 
	 * 
	 * @param completion
	 *            the completion value to set.
	 */
	public void setCompletion(double completion);
	
	
	/**
	 * Sets the internal {@link GanttEntry} {@link Completion}.
	 * 
	 * Is used to create relational start/end dependencies.
	 * 
	 * 
	 * @param range
	 *            the range value to set, dependend on the data type
	 *            T (see class description).
	 */
	public void setRange(Range range);
}