001/* Context.java --
002   Copyright (C) 2005, 2006 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 *
044 * This class holds the list of the named properties. It is normally
045 * used to represent information about various circumstances of the
046 * invocation. A Context if first created by
047 * {@link org.omg.CORBA.ORB#get_default_context() } and then invoking
048 * {@link #create_child(String)} of the default context.
049 *
050 * The contexts are named.
051 *
052 * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
053 *
054 */
055public abstract class Context
056{
057  public Context()
058  {
059  }
060
061  /**
062   * Get the context name.
063   * @return the name of this context.
064   */
065  public abstract String context_name();
066
067  /**
068   * Create a child of this Context, giving it a name.
069   * @param child a name of the child context.
070   *
071   * @return the newly created context.
072   */
073  public abstract Context create_child(String child);
074
075  /**
076   * Delete one or several (identically named) given properties.
077   *
078   * @param property the name of the property to delete, may
079   * end by wildchar character '*'. The search scope is always
080   * limited to the current context.
081   */
082  public abstract void delete_values(String property);
083
084  /**
085   * Search the values.
086   *
087   * @param start_scope the context at which to initiate the search.
088   * @param flags the search operation flags. 
089   * The flag {@link CTX_RESTRICT_SCOPE} means
090   * that search is restricted to the start_scope.
091   * @param pattern the property being searched, can be
092   * either name or name with the optional trailing wildchar character
093   * '*'.
094   * @return the list of the found properties.
095   */
096  public abstract NVList get_values(String start_scope, int flags,
097                                    String pattern
098                                   );
099
100  /**
101   * Get the parent of this context.
102   * @return the parent of this context.
103   */
104  public abstract Context parent();
105
106  /**
107   * Set a property.
108   * @param name the property name.
109   * @param value the property value (the {@link Any} must hold string).
110   */
111  public abstract void set_one_value(String name, Any value);
112  
113  /**
114   * Set multiple properties.
115   * 
116   * @param values a list of properties, the {@link Any}'s 
117   * in the list components must hold strings.
118   */
119  public abstract void set_values(NVList values);
120  
121  
122}