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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_reflection_XServiceConstructorDescription_idl__
  21 #define __com_sun_star_reflection_XServiceConstructorDescription_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25 module com {  module sun {  module star {  module reflection {
  26
  27 interface XCompoundTypeDescription;
  28 interface XParameter;
  29
  30 /**
  31    Reflects a service constructor.
  32
  33    @since OOo 2.0
  34  */
  35 interface XServiceConstructorDescription {
  36     /**
  37        Returns whether the constructor is a default constructor.
  38
  39        @return `TRUE` if the constructor is a default constructor
  40      */
  41     boolean isDefaultConstructor();
  42
  43     /**
  44        Returns the constructor's name.
  45
  46        @return the constructor's name; for a default constructor, an empty
  47            `string` is returned
  48      */
  49     string getName();
  50
  51     /**
  52        Returns the constructor's parameters.
  53
  54        @return the reflections of all the constructor's parameters, in their
  55            lexical order; for a default constructor, an empty sequence is
  56            returned
  57      */
  58     sequence<XParameter> getParameters();
  59
  60     /**
  61        Returns the exceptions that can be raised by the constructor.
  62
  63        @return the reflections of all the exceptions that are listed in the
  64        constructor's <code>raises</code> specification, in no particular order;
  65        all elements of the returned sequence will be reflections of exception
  66        types; for a default constructor, an empty sequence is returned (even
  67        though the mapping of a default constructor in a particular language
  68        binding may well raise certain UNO exceptions)
  69      */
  70     sequence<XCompoundTypeDescription> getExceptions();
  71 };
  72
  73 }; }; }; };
  74
  75 #endif
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */