TableConstraint.java

/* 
 *
 * SchemaCrawler
 * http://sourceforge.net/projects/schemacrawler
 * Copyright (c) 2000-2014, Sualeh Fatehi.
 *
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation;
 * either version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 */

package schemacrawler.schema;


import java.util.List;

/**
 * Represents a table constraint.
 * 
 * @author Sualeh Fatehi
 */
public interface TableConstraint
  extends DependantObject<Table>, TypedObject<TableConstraintType>,
  DefinedObject
{

  /**
   * Gets the list of columns in ordinal order.
   * 
   * @return Columns of the table constraint.
   */
  List<TableConstraintColumn> getColumns();

  /**
   * Gets the table constraint type.
   * 
   * @return Table constraint type
   */
  TableConstraintType getTableConstraintType();

  /**
   * Whether the constraint is deferrable.
   * 
   * @return Whether the constraint is deferrable
   */
  boolean isDeferrable();

  /**
   * Whether the constraint is initially deferred.
   * 
   * @return Whether the constraint is initially deferred
   */
  boolean isInitiallyDeferred();

}