UnitConversionModelService.java

/**
 * ***************************************************************************
 * Copyright (c) 2010 Qcadoo Limited
 * Project: Qcadoo Framework
 * Version: 1.4
 *
 * This file is part of Qcadoo.
 *
 * Qcadoo is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 * ***************************************************************************
 */
package com.qcadoo.model.api.units;

import java.util.List;

import com.qcadoo.model.api.DataDefinition;
import com.qcadoo.model.api.Entity;
import com.qcadoo.model.api.search.CustomRestriction;

/**
 * Unit conversion model service
 * 
 * @since 1.1.8
 * @author maku
 */
public interface UnitConversionModelService {

    /**
     * @param unit
     * @return list of unitConversionItem entities which represents conversion from/to given unit
     */
    List<Entity> find(final String unit);

    /**
     * @param unit
     * @param customRestriction
     * @return list of unitConversionItem entities which represents conversion from/to given unit and match additional
     *         restriction.
     */
    List<Entity> find(final String unit, final CustomRestriction customRestriction);

    /**
     * @return UnitConversionItem's DataDefinition instance
     */
    DataDefinition getDataDefinition();

}