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