udkapi/com/sun/star/reflection/XParameter.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_XParameter_idl__
  29 #define __com_sun_star_reflection_XParameter_idl__
  30
  31 #include "com/sun/star/reflection/XMethodParameter.idl"
  32
  33 module com {  module sun {  module star {  module reflection {
  34
  35 /**
  36    Reflects a parameter of an interface method or a service constructor.
  37
  38    <p>This type supersedes <type>XMethodParameter</type>, which only supports
  39    parameters of interface methods (which cannot have rest parameters).</p>
  40
  41    @since OOo 2.0.0
  42  */
  43 interface XParameter: XMethodParameter {
  44     /**
  45        Returns whether this is a rest parameter.
  46
  47        <p>A rest parameter must always come last in a parameter list.</p>
  48
  49        <p>Currently, only service constructors can have rest parameters, and
  50        those rest parameters must be in parameters of type <atom>any</atom>.</p>
  51
  52        @return <TRUE/> if and only if this parameter is a rest parameter
  53      */
  54     boolean isRestParameter();
  55 };
  56
  57 }; }; }; };
  58
  59 #endif