001/*
002 *  Copyright 2021 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.plugins.odfpilotage.cost.eqtd;
017
018import org.ametys.plugins.odfpilotage.cost.entity.ProgramItemData;
019import org.ametys.runtime.i18n.I18nizableText;
020
021/**
022 * Interface of a cost computation mode.
023 */
024public interface EqTDComputationMode
025{
026    /**
027     * Retrieves the id of the computation mode.
028     * @return the id.
029     */
030    public String getId();
031    
032    /**
033     * Retrieves the label of the computation mode.
034     * @return the label.
035     */
036    public I18nizableText getLabel();
037
038    /**
039     * Retrieves the description of the computation mode.
040     * @return the description.
041     */
042    public I18nizableText getDescription();
043
044    /**
045     * Compute the TD equivalent for the given course part data.
046     * @param programItemData The course part data
047     * @param eqTDCoef The TD equivalent coefficient
048     * @return The computed eqTD from the course part data
049     */
050    public Double computeEqTD(ProgramItemData programItemData, Double eqTDCoef);
051}