xdev.ui.ganttchart.action.GanttEntryController 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.action;

/*-
 * #%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 xdev.ui.ganttchart.UpdateableGanttEntry;

import com.jidesoft.gantt.GanttEntry;
import com.jidesoft.gantt.GanttEntryRelation;
import com.jidesoft.gantt.GanttModelEvent;


/**
 * Delegates {@link GanttModelEvent} actions.
 * 
 * 
 * @param 
 *            the gantt data type, for example Date or
 *            Integer.
 *            
 *            Used for entry scaling via {@link GanttEntry#getRange()}
 *            
 * 
 * @param 
 *            the customized {@link GanttEntry} type.
 * 
 * @author XDEV Software JWill
 * @since 4.0
 */
public interface GanttEntryController>
{
	/**
	 * Handles the proper update of the given {@link GanttEntry}.
	 * 
	 * Also takes care of the {@link GanttEntry} range restrictions through
	 * {@link GanttEntryRelation}s, if a {@link GanttRelationValidationStrategy}
	 * is set.
	 * 
	 * 
	 * 
	 * @param entry
	 *            the {@link GanttEntry} to update.
	 */
	public void updateEntry(S entry);
	
	
	/**
	 * Handles the propper deletion of the given {@link GanttEntry}.
	 * 
	 * @param entry
	 *            the {@link GanttEntry} to delete.
	 */
	public void removeEntry(S entry);
	
	
	/**
	 * Handles the propper insertion of the given {@link GanttEntry}.
	 * 
	 * @param entry
	 *            the {@link GanttEntry} to insert.
	 */
	public void insertEntry(S entry);
	
	
	/**
	 * @param relationValidationStrategy
	 *            the {@link GanttRelationValidationStrategy} to set.
	 */
	public void setRelationValidationStrategy(
			GanttRelationValidationStrategy relationValidationStrategy);
	
	
	/**
	 * @return the {@link GanttRelationValidationStrategy}.
	 */
	public GanttRelationValidationStrategy getRelationValidationStrategy();
	
}