/* DynUnion.java --
   Copyright (C) 2005 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath 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, or (at your option)
any later version.

GNU Classpath 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 GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package org.omg.CORBA;


/**
 * Represents the {@link DynAny}, holding the CORBA structure (variant record
 * with the named fields). The internal reference, described in
 * {@link DynAny#current_component()}, iterates over the fields of the
 * member, stored in the union. The union always holds only one member;
 * which one, depends from the value of the discriminator.
 *
 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
 */
public interface DynUnion
  extends DynAny
{
  /**
   * Returns the discriminator, defining, which set of fields is stored.
   * @return the discriminator.
   */
  DynAny discriminator();

  /**
   * Returns the discriminator kind.
   */
  TCKind discriminator_kind();

  /**
   * Returns the member, stored in this union.
   */
  DynAny member();

  /**
   * Returns the kind of the member, stored in this union.
   */
  TCKind member_kind();

  /**
   * Returns the name of the currently focused member.
   */
  String member_name();

  /**
   * Renames the currently focused member.
   *
   * @param new_name the new name of the currently focused member.
   */
  void member_name(String new_name);

  /**
   * Checks if the discriminator of this union has been assigned a valid
   * default value.
   */
  boolean set_as_default();

  /**
   * Determines if the discriminator of this union gets assigned a valid
   * default value.
   * @param assign_default
   */
  void set_as_default(boolean assign_default);
}
