IRObjectOperations.java revision 608:7e06bf1dcb09 
1/*
2 * Copyright (c) 1999, 2001, 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 */
25package org.omg.CORBA;
26
27
28/**
29* The interface for <tt>IRObject</tt>.  For more information on
30* Operations interfaces, see <a href="doc-files/generatedfiles.html#operations">
31* "Generated Files: Operations files"</a>.
32*/
33
34/*
35 tempout/org/omg/CORBA/IRObjectOperations.java
36 Generated by the IBM IDL-to-Java compiler, version 1.0
37 from ../../Lib/ir.idl
38 Thursday, February 25, 1999 2:11:21 o'clock PM PST
39*/
40
41/**
42 * This is the Operations interface for the mapping from <tt>IRObject</tt>.
43 * Several interfaces are used as base interfaces for objects in
44 * the Interface Repository (IR). These base interfaces are not instantiable.
45 * A common set of operations is used to locate objects within the
46 * Interface Repository. Some of these operations are defined in
47 * the IRObject. All IR objects inherit from the IRObject interface,
48 * which provides an operation for identifying the actual type of
49 * the object. (The IDL base interface IRObject represents the most
50 * generic interface from which all other Interface Repository interfaces
51 * are derived, even the Repository itself.) All java implementations of
52 * IR objects must implement the IRObjectOperations interface.
53 * @see IDLTypeOperations
54 * @see IDLType
55 * @see IRObject
56 */
57public interface IRObjectOperations
58{
59
60    // read interface
61    /**
62     * Returns the <code>DefinitionKind</code> corresponding to this Interface Repository object.
63     * @return the <code>DefinitionKind</code> corresponding to this Interface Repository object.
64     */
65    org.omg.CORBA.DefinitionKind def_kind ();
66
67    // write interface
68    /**
69     * Destroys this object. If the object is a Container,
70     * this method is applied to all its contents. If the object contains an IDLType
71     * attribute for an anonymous type, that IDLType is destroyed.
72     * If the object is currently contained in some other object, it is removed.
73     * If the method is invoked on a <code>Repository</code> or on a <code>PrimitiveDef</code>
74     * then the <code>BAD_INV_ORDER</code> exception is raised with minor value 2.
75     * An attempt to destroy an object that would leave the repository in an
76     * incoherent state causes <code>BAD_INV_ORDER</code> exception to be raised
77     * with the minor code 1.
78     * @exception BAD_INV_ORDER if this method is invoked on a repository or
79     *            <code>PrimitiveDef</code>, or if an attempt to destroy an
80     *            object would leave the repository in an incoherent state
81     */
82    void destroy ();
83} // interface IRObjectOperations
84