udkapi/com/sun/star/reflection/XServiceConstructorDescription.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_reflection_XServiceConstructorDescription2_idl__
  29 #define __com_sun_star_reflection_XServiceConstructorDescription2_idl__
  30
  31 #include "com/sun/star/uno/XInterface.idl"
  32
  33 module com {  module sun {  module star {  module reflection {
  34
  35 interface XCompoundTypeDescription;
  36 interface XParameter;
  37
  38 /**
  39    Reflects a service constructor.
  40
  41    @since OOo 2.0.0
  42  */
  43 interface XServiceConstructorDescription {
  44     /**
  45        Returns whether the constructor is a default constructor.
  46
  47        @return <TRUE/> if the constructor is a default constructor
  48      */
  49     boolean isDefaultConstructor();
  50
  51     /**
  52        Returns the constructor's name.
  53
  54        @return the constructor's name; for a default constructor, an empty
  55            <atom>string</atom> is returned
  56      */
  57     string getName();
  58
  59     /**
  60        Returns the constructor's parameters.
  61
  62        @return the reflections of all the constructor's parameters, in their
  63            lexical order; for a default constructor, an empty sequence is
  64            returned
  65      */
  66     sequence<XParameter> getParameters();
  67
  68     /**
  69        Returns the exceptions that can be raised by the constructor.
  70
  71        @return the reflections of all the exceptions that are listed in the
  72        constructor's <code>raises</code> specification, in no particular order;
  73        all elements of the returned sequence will be reflections of exception
  74        types; for a default constructor, an empty sequence is returned (even
  75        though the mapping of a default constructor in a particular language
  76        binding may well raise certain UNO exceptions)
  77      */
  78     sequence<XCompoundTypeDescription> getExceptions();
  79 };
  80
  81 }; }; }; };
  82
  83 #endif