org.cp.elements.biz.rules.Rule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cp-elements Show documentation

Java Simplified. Extensions and Useful Constructs for the Java Platform. Codeprimate Elements (a.k.a. cp-elements) is a Java library and micro-framework used to simplify the development of software applications written in Java. Elements packages several APIs into one library in order to address various application concerns and aspects of software design and development collectively and conveniently. Elements is a highly simple, yet robust and proven library built on solid OO principles, software design patterns and best practices to effectively solve common and reoccurring problems in software development.

There is a newer version: 2.0.0-M1

Show newest version

/*
 * Copyright 2016 Author or Authors.
 *
 * 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.
 */

package org.cp.elements.biz.rules;

import org.cp.elements.lang.Identifiable;

/**
 * The Rule interface is an abstraction for modeling a business rule.
 *
 * @author John J. Blum
 * @param  the Class type of objects evaluated by this business rule.
 * @see org.cp.elements.lang.Identifiable
 * @since 1.0.0
 */
@SuppressWarnings("unused")
public interface Rule> extends Identifiable {

  /**
   * Determines the outcome expected when evaluating an object with this business rule.  The object is expected to
   * satisfy or violate the criteria of this business rule when evaluated.
   *
   * @return the outcome expected when evaluating an object with this business rule.
   * @see #evaluate(Object)
   */
  boolean getExpectedOutcome();

  /**
   * Indicates if this business rule is configured to throw an exception on failure when evaluated.  If the object
   * evaluated by this business rule violates the criteria, then an exception is thrown.
   *
   * @return a boolean value indicating whether this business rule is configured to throw an exception on failure
   * when evaluated.
   * @see #evaluate(Object)
   */
  boolean isThrowExceptionOnFailure();

  /**
   * Evaluates the specified object against the criteria, or requirements of this business rule.
   *
   * @param obj the Object evaluated by this business rule.
   * @return a boolean value indicating whether the object evaluated satisfied the criteria of this business rule.
   * @see #isThrowExceptionOnFailure()
   * @see #getExpectedOutcome()
   */
  boolean evaluate(T obj);

}