Environment.java revision 608:7e06bf1dcb09 
1/*
2 * Copyright (c) 1996, 1999, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package org.omg.CORBA;
27
28/**
29 * A container (holder) for an exception that is used in <code>Request</code>
30 * operations to make exceptions available to the client.  An
31 * <code>Environment</code> object is created with the <code>ORB</code>
32 * method <code>create_environment</code>.
33 *
34 * @since   JDK1.2
35 */
36
37public abstract class Environment {
38
39    /**
40     * Retrieves the exception in this <code>Environment</code> object.
41     *
42     * @return                  the exception in this <code>Environment</code> object
43     */
44
45    public abstract java.lang.Exception exception();
46
47    /**
48     * Inserts the given exception into this <code>Environment</code> object.
49     *
50     * @param except            the exception to be set
51     */
52
53    public abstract void exception(java.lang.Exception except);
54
55    /**
56     * Clears this <code>Environment</code> object of its exception.
57     */
58
59    public abstract void clear();
60
61}
62