hu.icellmobilsoft.coffee.module.ruleng.rule.IRule Maven / Gradle / Ivy
/*-
* #%L
* Coffee
* %%
* Copyright (C) 2020 i-Cell Mobilsoft Zrt.
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
package hu.icellmobilsoft.coffee.module.ruleng.rule;
import java.util.Collections;
import java.util.List;
import hu.icellmobilsoft.coffee.se.api.exception.BaseException;
/**
* General rule interface
*
* @author imre.scheffer
* @param
* The class type of the input object on which the rule can be applied.
* @param
* The class type of the evaluation result.
* @since 1.0.0
*/
public interface IRule {
/**
* Rule evaluation
*
* @param input
* object to be evaluated
* @return evaluation result
* @throws RuleException
* error violating the rule evaluation
* @throws BaseException
* General, unexpected error during evaluation
*/
RULERESULT apply(INPUT input) throws RuleException, BaseException;
/**
* Evaluation with multiple results
*
* @param input
* object to be evaluated
* @return evaluation result
* @throws RuleException
* error violating the rule evaluation
* @throws BaseException
* General, unexpected error during evaluation
*/
default List applyList(INPUT input) throws RuleException, BaseException {
return Collections.emptyList();
}
}