offapi/com/sun/star/configuration/backend/XSchema.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: XSchema.idl,v $
  10  * $Revision: 1.7 $
  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_XSchema_idl__
  31 #define __com_sun_star_configuration_backend_XSchema_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_XSchemaHandler_idl__
  38 #include <com/sun/star/configuration/backend/XSchemaHandler.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_NullPointerException_idl__
  42 #include <com/sun/star/lang/NullPointerException.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  46 #include <com/sun/star/lang/WrappedTargetException.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__
  50 #include <com/sun/star/configuration/backend/MalformedDataException.idl>
  51 #endif
  52
  53 //=============================================================================
  54
  55 module com { module sun { module star { module configuration { module backend {
  56
  57 //=============================================================================
  58
  59 /**
  60   Handles access to the elements of a component schema,
  61   i.e its templates and its component definition.
  62
  63     @since OOo 1.1.2
  64 */
  65 published interface XSchema : ::com::sun::star::uno::XInterface
  66 {
  67     //-------------------------------------------------------------------------
  68
  69     /**
  70       Describes the full schema (templates + component) to a
  71       <type>XSchemaHandler</type>.
  72
  73       @param aHandler
  74             schema handler that will receive calls
  75             describing the contents of the templates
  76             and the component definition
  77
  78       @throws com::sun::star::lang::NullPointerException
  79               if a <NULL/> handler is passed.
  80       @throws com::sun::star::lang::WrappedTargetException
  81               if an error occurs in the access to or processing of the data or
  82               if a subsequent call to any of the <type>XSchema</type>methods is made.
  83               The elements of a component schema are only parsed once,a repeat call
  84               leads to exception.
  85       @throws com::sun::star::configuration::backend::MalformedDataException
  86               if the data read from the layer is rejected as invalid by the
  87               <type>XSchemaHandler</type>.
  88     */
  89     void readSchema([in] XSchemaHandler aHandler)
  90         raises (com::sun::star::lang::NullPointerException,
  91                 com::sun::star::lang::WrappedTargetException,
  92                 MalformedDataException) ;
  93
  94     //-------------------------------------------------------------------------
  95
  96     /**
  97       Describes only the component definition to a <type>XSchemaHandler</type>.
  98
  99       @param aHandler
 100             schema handler that will receive calls
 101             describing the contents of the component
 102             definition
 103
 104       @throws com::sun::star::lang::NullPointerException
 105               if a <NULL/> handler is passed.
 106       @throws com::sun::star::lang::WrappedTargetException
 107               if an error occurs in the access to or processing of the data or
 108               if a subsequent call to any of the <type>XSchema</type>methods is made.
 109               The elements of a component schema are only parsed once,a repeat call
 110               leads to exception.
 111       @throws com::sun::star::configuration::backend::MalformedDataException
 112               if the data read from the layer is rejected as invalid by the
 113               <type>XSchemaHandler</type>.
 114     */
 115     void readComponent([in] XSchemaHandler aHandler)
 116         raises (com::sun::star::lang::NullPointerException,
 117                 com::sun::star::lang::WrappedTargetException,
 118                 MalformedDataException) ;
 119
 120     //-------------------------------------------------------------------------
 121
 122     /**
 123       Describes the component templates to a <type>XSchemaHandler</type>.
 124
 125       @param aHandler
 126             schema handler that will receive calls
 127             describing the contents of the templates
 128
 129       @throws com::sun::star::lang::NullPointerException
 130               if a <NULL/> handler is passed.
 131       @throws com::sun::star::lang::WrappedTargetException
 132               if an error occurs in the access to or processing of the data or
 133               if a subsequent call to any of the <type>XSchema</type>methods is made.
 134               The elements of a component schema are only parsed once,a repeat call
 135               leads to exception.
 136       @throws com::sun::star::configuration::backend::MalformedDataException
 137               if the data read from the layer is rejected as invalid by the
 138               <type>XSchemaHandler</type>.
 139     */
 140     void readTemplates([in] XSchemaHandler aHandler)
 141         raises (com::sun::star::lang::NullPointerException,
 142                 com::sun::star::lang::WrappedTargetException,
 143                 MalformedDataException) ;
 144
 145     //-------------------------------------------------------------------------
 146 } ;
 147
 148 //=============================================================================
 149
 150 } ; } ; } ; } ; } ;
 151 #endif