001/* DynEnum.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
041
042/**
043 * Represents the dynamic enumeration, allowing to get/set the value by
044 * name or by position in the enumeration list. The CORBA enumeration
045 * can obtain one of the named values from the specified enumeration list.
046 *
047 * @deprecated by {@link org.omg.DynamicAny.DynEnum}
048 *
049 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
050 */
051public interface DynEnum
052  extends DynAny
053{
054  /**
055   * Get the value of this object.
056   * @return the currently set value, one of the allowed values
057   * for this enumeration.
058   */
059  String value_as_string();
060
061  /**
062   * Set the value of this object.
063   *
064   * @param member the value to set, must be one of the allowed values for
065   * this enumeration. Otherwise the {@link SystemException} may be thrown.
066   */
067  void value_as_string(String member);
068
069  /**
070   * Set the value of this object as the position inside the list of this
071   * enumeration.
072   *
073   * @param member the position of the enumeration value inside
074   * the enumeration list. Otherwise the {@link SystemException} may be thrown.
075   */
076  void value_as_ulong(int member);
077
078  /**
079   * Get the value of this object as the position inside the list of this
080   * enumeration.
081   *
082   * @return member the position of the currently set enumeration value inside
083   * the enumeration list.
084   */
085  int value_as_ulong();
086}