FormItemDependencyRule.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.  
* <p>
*/
package org.olat.core.gui.components.form.flexible;

import java.util.Set;


/**
 * Description:<br>
 * TODO: patrickb Class Description for FormItemDependencyRule
 * 
 * <P>
 * Initial Date:  09.02.2007 <br>
 * @author patrickb
 */
public interface FormItemDependencyRule {
	/**
	 * which form element triggers this rule
	 * @return
	 */
	public FormItem getTriggerElement();

	/**
	 * which trigger value in the form element
	 * @return
	 */
	public Object getTriggerValue();
	
	/**
	 * 
	 * @return
	 */
	public Set<FormItem> getTargetElements();
	
	/**
	 * Checks if rule is triggered and executes the desired actions on the target
	 * elements.
	 * returns true if rule was applied
	 */
	public boolean applyRule(FormItemContainer layoutContainer);
	
	/**
	 * identify this rule without taking the target elements into account.
	 * 
	 * @return
	 */
	public String getIdentifier();
	
	/**
	 * 
	 * @param applayable
	 */
	public void setDependencyRuleApplayable(DependencyRuleApplayable applayable);
}