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 module com {  module sun {  module star {  module reflection {
  21
  22 interface XCompoundTypeDescription;
  23 interface XParameter;
  24
  25 /**
  26    Reflects a service constructor.
  27
  28    @since OOo 2.0
  29  */
  30 interface XServiceConstructorDescription {
  31     /**
  32        Returns whether the constructor is a default constructor.
  33
  34        @return `TRUE` if the constructor is a default constructor
  35      */
  36     boolean isDefaultConstructor();
  37
  38     /**
  39        Returns the constructor's name.
  40
  41        @return the constructor's name; for a default constructor, an empty
  42            `string` is returned
  43      */
  44     string getName();
  45
  46     /**
  47        Returns the constructor's parameters.
  48
  49        @return the reflections of all the constructor's parameters, in their
  50            lexical order; for a default constructor, an empty sequence is
  51            returned
  52      */
  53     sequence<XParameter> getParameters();
  54
  55     /**
  56        Returns the exceptions that can be raised by the constructor.
  57
  58        @return the reflections of all the exceptions that are listed in the
  59        constructor's <code>raises</code> specification, in no particular order;
  60        all elements of the returned sequence will be reflections of exception
  61        types; for a default constructor, an empty sequence is returned (even
  62        though the mapping of a default constructor in a particular language
  63        binding may well raise certain UNO exceptions)
  64      */
  65     sequence<XCompoundTypeDescription> getExceptions();
  66 };
  67
  68 }; }; }; };
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */