001 /* DynEnum.java --
002 Copyright (C) 2005, 2007 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package 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 */
051 public 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 }