ip_field.java

/*

   ip_field.java

   Remote interface definition.

   Created: 4 Sep 1997

   Module By: Jonathan Abbey, jonabbey@arlut.utexas.edu

   -----------------------------------------------------------------------

   Ganymede Directory Management System

   Copyright (C) 1996-2013
   The University of Texas at Austin

   Ganymede is a registered trademark of The University of Texas at Austin

   Contact information

   Author Email: ganymede_author@arlut.utexas.edu
   Email mailing list: ganymede@arlut.utexas.edu

   US Mail:

   Computer Science Division
   Applied Research Laboratories
   The University of Texas at Austin
   PO Box 8029, Austin TX 78713-8029

   Telephone: (512) 835-3200

   This program 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.

   This program 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 General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.

*/

package arlut.csd.ganymede.rmi;

import java.rmi.RemoteException;

/**
 * <p>Remote RMI reference to a Ganymede {@link
 * arlut.csd.ganymede.server.IPDBField IPDBField}.</p>
 *
 * <p>ip_field is an extension of the {@link
 * arlut.csd.ganymede.rmi.db_field} interface, and provides a set of
 * additional methods that the client can use to query the status and
 * acceptable data types for an IP Address field.</p>
 */

public interface ip_field extends db_field {

  /**
   * <p>Returns true if this field is permitted to hold IPv6
   * addresses.</p>
   */

  boolean v6Allowed() throws RemoteException;

  /**
   * <p>Returns true if the (scalar) value stored in this IP field is
   * an IPV6 address.</p>
   */

  boolean isIPV6() throws RemoteException;

  /**
   * <p>Returns true if the (scalar) value stored in this IP field is
   * an IPV6 address.</p>
   */

  boolean isIPV4() throws RemoteException;

  /**
   * <p>Returns true if the value stored in the given element of this
   * IP field is an IPV6 address.</p>
   *
   * @param index Array index for the value to be checked
   */

  boolean isIPV6(short index) throws RemoteException;

  /**
   * <p>Returns true if the value stored in the given element of this
   * IP field is an IPV4 address.</p>
   *
   * @param index Array index for the value to be checked
   */

  boolean isIPV4(short index) throws RemoteException;
}