1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski package com.sun.star.uno;
25*b1cdbd2cSJim Jagielski 
26*b1cdbd2cSJim Jagielski /**
27*b1cdbd2cSJim Jagielski  * This is the delegator interface for Java objects implementing interfaces of
28*b1cdbd2cSJim Jagielski  * an underlying UNO object.
29*b1cdbd2cSJim Jagielski  *
30*b1cdbd2cSJim Jagielski  * <p>Calls are delegated through the <code>UnoRuntime</code> to this
31*b1cdbd2cSJim Jagielski  * interface.  Implement this interface in case you want to customize the
32*b1cdbd2cSJim Jagielski  * behaviour of <code>UnoRuntime.queryInterface</code>.</p>
33*b1cdbd2cSJim Jagielski  *
34*b1cdbd2cSJim Jagielski  * @see com.sun.star.uno.UnoRuntime
35*b1cdbd2cSJim Jagielski  */
36*b1cdbd2cSJim Jagielski public interface IQueryInterface {
37*b1cdbd2cSJim Jagielski     /**
38*b1cdbd2cSJim Jagielski      * Returns the unique object identifier (OID) of the underlying UNO object.
39*b1cdbd2cSJim Jagielski      *
40*b1cdbd2cSJim Jagielski      * @return the OID of the underlying object
41*b1cdbd2cSJim Jagielski      */
getOid()42*b1cdbd2cSJim Jagielski     String getOid();
43*b1cdbd2cSJim Jagielski 
44*b1cdbd2cSJim Jagielski     /**
45*b1cdbd2cSJim Jagielski      * Returns an object implementing the requested interface type.
46*b1cdbd2cSJim Jagielski      *
47*b1cdbd2cSJim Jagielski      * @param type the requested UNO interface type; must be a <code>Type</code>
48*b1cdbd2cSJim Jagielski      * object representing a UNO interface type
49*b1cdbd2cSJim Jagielski      * @return a reference to the requested UNO interface type if available,
50*b1cdbd2cSJim Jagielski      * otherwise <code>null</code>
51*b1cdbd2cSJim Jagielski      * @see com.sun.star.uno.UnoRuntime
52*b1cdbd2cSJim Jagielski      */
queryInterface(Type type)53*b1cdbd2cSJim Jagielski     Object queryInterface(Type type);
54*b1cdbd2cSJim Jagielski 
55*b1cdbd2cSJim Jagielski     /**
56*b1cdbd2cSJim Jagielski      * Tests if the given reference represents a facet of the underlying UNO
57*b1cdbd2cSJim Jagielski      * object.
58*b1cdbd2cSJim Jagielski      *
59*b1cdbd2cSJim Jagielski      * @param object a reference to any Java object representing (a facet of) a
60*b1cdbd2cSJim Jagielski      * UNO object; may be <code>null</code>
61*b1cdbd2cSJim Jagielski      * @return <code>true</code> if and only if <code>object</code> is not
62*b1cdbd2cSJim Jagielski      * <code>null</code> and represents the same UNO object as this object
63*b1cdbd2cSJim Jagielski      */
isSame(Object object)64*b1cdbd2cSJim Jagielski     boolean isSame(Object object);
65*b1cdbd2cSJim Jagielski }
66