org.openl.ie.constrainer.IntBoolExp Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.openl.rules.constrainer Show documentation

OpenL Constraint Programming engine

There is a newer version: 5.27.9

Show newest version

package org.openl.ie.constrainer;

///////////////////////////////////////////////////////////////////////////////
/*
 * Copyright Exigen Group 1998, 1999, 2000
 * 320 Amboy Ave., Metuchen, NJ, 08840, USA, www.exigengroup.com
 *
 * The copyright to the computer program(s) herein
 * is the property of Exigen Group, USA. All rights reserved.
 * The program(s) may be used and/or copied only with
 * the written permission of Exigen Group
 * or in accordance with the terms and conditions
 * stipulated in the agreement/contract under which
 * the program(s) have been supplied.
 */
///////////////////////////////////////////////////////////////////////////////
/**
 * An interface for the constraint boolean expression as an [0..1] integer expression where 0 is false and 1 is true.
 */
public interface IntBoolExp extends IntExp {
    /**
     * Returns the boolean expression: (this && value)
     */
    IntBoolExp and(boolean value);

    /**
     * Returns the boolean expression: (this && exp)
     */
    IntBoolExp and(IntBoolExp exp);

    /**
     * Returns the Constraint that corresponds to this expression.
     */
    Constraint asConstraint();

    /**
     * Returns true if the expression is false. Note: this is not equals to !isTrue()
     */
    boolean isFalse();

    /**
     * Returns true if the expression is true. Note: this is not equals to !isFalse()
     */
    boolean isTrue();

    /**
     * Returns the boolean expression: (this || value)
     */
    IntBoolExp or(boolean value);

    /**
     * Returns the boolean expression: (this || exp)
     */
    IntBoolExp or(IntBoolExp exp);

    /**
     * Sets the expression to be false.
     *
     * @throws Failure if expression is bound to be true.
     */
    void setFalse() throws Failure;

    /**
     * Sets the expression to be true.
     *
     * @throws Failure if expression is bound to be false.
     */
    void setTrue() throws Failure;

} // ~IntBoolExp