offapi/com/sun/star/configuration/backend/XCompositeLayer.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: XCompositeLayer.idl,v $
  10  * $Revision: 1.6 $
  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
  31 #ifndef __com_sun_star_configuration_backend_XCompositeLayer_idl__
  32 #define __com_sun_star_configuration_backend_XCompositeLayer_idl__
  33
  34 #ifndef __com_sun_star_configuration_backend_XLayer_idl__
  35 #include <com/sun/star/configuration/backend/XLayer.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_NullPointerException_idl__
  39 #include <com/sun/star/lang/NullPointerException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  43 #include <com/sun/star/lang/IllegalArgumentException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  47 #include <com/sun/star/lang/WrappedTargetException.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__
  51 #include <com/sun/star/configuration/backend/MalformedDataException.idl>
  52 #endif
  53
  54 //==============================================================================
  55
  56 module com { module sun { module star { module configuration { module backend {
  57
  58 //==============================================================================
  59
  60 /**
  61   provides read access to layers that contain sublayers accessible through an
  62   additional criterion (for instance the locale they contain data for).
  63
  64     @since OOo 1.1.2
  65   */
  66 published interface XCompositeLayer : XLayer
  67 {
  68     //--------------------------------------------------------------------------
  69
  70     /**
  71       Returns a list of the criteria that can be used to access the
  72       sublayers.
  73
  74       @return
  75             a list supported sublayer identifiers
  76
  77       @throws com::sun::star::lang::WrappedTargetException
  78             if an error occurs in the retrieval of the data.
  79       */
  80     sequence<string> listSubLayerIds()
  81         raises (com::sun::star::lang::WrappedTargetException) ;
  82
  83     //--------------------------------------------------------------------------
  84
  85     /**
  86       Describes the content of a particular sublayer to
  87       an <type>XLayerHandler</type>.
  88
  89       @param aHandler
  90             Handler object that will receive calls
  91             describing the contents of the sublayer.
  92
  93       @param aSubLayerId
  94             Identifier of the sublayer to be read.
  95             <p> Must be one the identifiers returned by
  96                 <member>XCompositeLayer::listSubLayerIds()</member>
  97             </p>
  98
  99       @throws com::sun::star::lang::NullPointerException
 100               if a <NULL/> handler is passed.
 101       @throws com::sun::star::lang::IllegalArgumentException
 102               if the identifier is invalid.
 103       @throws com::sun::star::lang::WrappedTargetException
 104               if an error occurs in the access to or processing of the data.
 105       @throws com::sun::star::configuration::backend::MalformedDataException
 106               if the data read from the layer is rejected as invalid by the
 107               <type>XLayerHandler</type>.
 108       */
 109     void readSubLayerData([in] XLayerHandler aHandler, [in] string aSubLayerId)
 110         raises (com::sun::star::lang::NullPointerException,
 111                 com::sun::star::lang::IllegalArgumentException,
 112                 com::sun::star::lang::WrappedTargetException,
 113                 MalformedDataException) ;
 114
 115     //--------------------------------------------------------------------------
 116 } ;
 117
 118 //==============================================================================
 119
 120 } ; } ; } ; } ; } ;
 121 #endif