offapi/com/sun/star/configuration/backend/XSchemaSupplier.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 #ifndef __com_sun_star_configuration_backend_XSchemaSupplier_idl__
  28 #define __com_sun_star_configuration_backend_XSchemaSupplier_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_configuration_backend_XSchema_idl__
  35 #include <com/sun/star/configuration/backend/XSchema.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__
  39 #include <com/sun/star/configuration/backend/BackendAccessException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  43 #include <com/sun/star/lang/IllegalArgumentException.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com { module sun { module star { module configuration { module backend {
  49
  50 //=============================================================================
  51
  52 /**
  53   provides access to configuration component schemas.
  54
  55   @since OOo 1.1.2
  56 */
  57 published interface XSchemaSupplier : ::com::sun::star::uno::XInterface
  58 {
  59     //-------------------------------------------------------------------------
  60
  61     /**
  62       Returns the schema information (component + templates)
  63       for a particular component.
  64
  65       @param aComponent
  66                 component whose schema will be accessed
  67
  68       @returns
  69                 an object allowing access to the various parts of the schema,
  70                 <NULL/> if the component doesn't exist.
  71
  72       @throws   com::sun::star::lang::IllegalArgumentException
  73                 if the component identifier is invalid.
  74
  75       @throws   com::sun::star::configuration::backend::BackendAccessException
  76                 if an error occurs while accessing the data.
  77     */
  78     XSchema getComponentSchema([in] string aComponent)
  79         raises (BackendAccessException,
  80                 com::sun::star::lang::IllegalArgumentException) ;
  81
  82     //-------------------------------------------------------------------------
  83 } ;
  84
  85 //=============================================================================
  86
  87 } ; } ; } ; } ; } ;
  88
  89 #endif