001/* DynStruct.java --
002   Copyright (C) 2005, 2007 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package org.omg.CORBA;
040
041import org.omg.CORBA.DynAnyPackage.InvalidSeq;
042
043/**
044 * Represents the {@link DynAny}, holding the CORBA structure (record
045 * with the named fields). The internal reference, described in
046 * {@link DynAny#current_component()}, iterates over the fields of the
047 * structure.
048 *
049 * @deprecated by {@link org.omg.DynamicAny.DynStruct}
050 *
051 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
052 */
053public interface DynStruct
054  extends DynAny
055{
056/**
057 * Get the kind of the structure field that would be returned by
058 * {@link DynAny#current_component()}.
059 *
060 * @return the kind of the structure field.
061 */
062  TCKind current_member_kind();
063
064  /**
065   * Get the name of the structure field that would be returned by
066   * {@link DynAny#current_component()}.
067   *
068   * @return the name of the structure field.
069   */
070  String current_member_name();
071
072  /**
073   * Get all fields of the structure in the array of the named values,
074   * holding name, repository id and value of the associated field.
075   *
076   * @return members the array of the named values,
077   * representing the structure fields.
078   */
079  NameValuePair[] get_members();
080
081  /**
082   * Set all fields of this structure by name.
083   *
084   * @param members the array of the named values,
085   * representing the structure fields.
086   *
087   * @throws InvalidSeq if the passed argument is invalid.
088   */
089  void set_members(NameValuePair[] members)
090            throws InvalidSeq;
091}