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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XIdlField2.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_reflection_XIdlField2_idl__
  31 #define __com_sun_star_reflection_XIdlField2_idl__
  32
  33 #ifndef __com_sun_star_reflection_XIdlMember_idl__
  34 #include <com/sun/star/reflection/XIdlMember.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_reflection_XIdlClass_idl__
  38 #include <com/sun/star/reflection/XIdlClass.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_reflection_FieldAccessMode_idl__
  42 #include <com/sun/star/reflection/FieldAccessMode.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  46 #include <com/sun/star/lang/IllegalArgumentException.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_lang_IllegalAccessException_idl__
  50 #include <com/sun/star/lang/IllegalAccessException.idl>
  51 #endif
  52
  53
  54 //=============================================================================
  55
  56  module com {  module sun {  module star {  module reflection {
  57
  58 //=============================================================================
  59
  60 /** Reflects an IDL interface attribute, enum or compound type
  61     (i.e. struct/exception) member.
  62 */
  63 published interface XIdlField2: com::sun::star::reflection::XIdlMember
  64 {
  65     /** Returns the type of the field.
  66
  67         @return
  68                 type of the field
  69     */
  70     com::sun::star::reflection::XIdlClass getType();
  71
  72     /** Returns the access mode of the field, i.e. read-write, read-only or
  73         write-only (access mode "const" is deprecated).
  74
  75         @return
  76                 access mode of the field
  77     */
  78     com::sun::star::reflection::FieldAccessMode getAccessMode();
  79
  80     /** Gets the value of the reflected field from the given object,
  81         i.e. an interface, enum or compound type (struct/exception).
  82         For enums, the given object is ignored; the returned value
  83         reflects the constant enum 32-bit value.
  84
  85         <p>When setting an interface attribute raises a
  86         non-<type scope="com::sun::star::uno">RuntimeException</type>, it is
  87         wrapped in a <type
  88         scope="com::sun::star::lang">WrappedTargetRuntimeException</type>.</p>
  89
  90         @param obj
  91                object instance having member of reflected type
  92         @return
  93                 value of field
  94
  95         @throws IllegalAccessException
  96         An <type scope="com::sun::star::lang">IllegalAccessException</type>
  97         is thrown if the given object is no interface, enum or compound type;
  98         or the given object does not have the reflected field.
  99     */
 100     any get(
 101         [in] any obj )
 102         raises( com::sun::star::lang::IllegalArgumentException );
 103
 104     /** Sets the value of the reflected field of the given object,
 105         i.e. an interface or compound type (struct/exception).
 106
 107         <p>When setting an interface attribute raises a
 108         non-<type scope="com::sun::star::uno">RuntimeException</type>, it is
 109         wrapped in a <type
 110         scope="com::sun::star::lang">WrappedTargetRuntimeException</type>.</p>
 111
 112         @param obj
 113                object instance having member of reflected type
 114         @param value
 115                value to be set
 116
 117         @throws IllegalAccessException
 118         An <type scope="com::sun::star::lang">IllegalAccessException</type>
 119         is thrown if the given object is no interface or compound type;
 120         or the given object does not have the reflected field.
 121     */
 122     void set(
 123         [inout] any obj,
 124         [in] any value )
 125         raises( com::sun::star::lang::IllegalArgumentException,
 126                 com::sun::star::lang::IllegalAccessException );
 127 };
 128
 129 //=============================================================================
 130
 131 }; }; }; };
 132
 133 /*=============================================================================
 134
 135 =============================================================================*/
 136 #endif