xdev.ui.ganttchart.action.GanttRelationManagementController 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 xdev.ui.ganttchart.model.GanttRelationPersistence;

import com.jidesoft.gantt.GanttEntry;


/**
 * This is the controller layer between {@link GanttRelationPersistence} and the
 * GanttChart relation view.
 * 
 * 
 * If the upcoming GanttRelations aren�t legal, special implementation details
 * notify the user about the mistake.
 * 
 * 
 * @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
 * 
 * @see GanttRelationValidationStrategy
 * 
 */
public interface GanttRelationManagementController, S extends UpdateableGanttEntry>
{
	/**
	 * Validates the upcomming entry relationship.
	 * 
	 * Concrete implementations like {@link StSRelationManagementController}
	 * verify the entries start and end
	 * 
	 * 
	 * @param precessor
	 *            the precessor entry of the relationship.
	 * @param sucessor
	 *            the sucessor entry of the relationship.
	 * @return returns the validation boolean.
	 * 
	 * @see FtFRelationManagementController
	 * @see StFRelationManagementController
	 */
	public boolean validateEntryRelation(S precessor, S sucessor);
}