com.caucho.amber.entity.Embeddable Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 1998-2018 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source 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, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Rodrigo Westrupp
 */

package com.caucho.amber.entity;

import com.caucho.amber.manager.AmberConnection;

import java.sql.ResultSet;
import java.sql.SQLException;

/**
 * An embeddable object.
 */
public interface Embeddable {

  /**
   * Loads the embeddable object from the
   * database and returns the number of columns
   * consumed from the result set.
   */
  public int __caucho_load(AmberConnection aConn,
                           ResultSet rs,
                           int index)
    throws SQLException;

  /**
   * Returns the ith field.
   */
  public Object __caucho_get_field(int index);
}