1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_configuration_backend_XSchema_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_configuration_backend_XSchema_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_configuration_backend_XSchemaHandler_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/configuration/backend/XSchemaHandler.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_NullPointerException_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/NullPointerException.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 39*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/WrappedTargetException.idl> 40*b1cdbd2cSJim Jagielski#endif 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__ 43*b1cdbd2cSJim Jagielski#include <com/sun/star/configuration/backend/MalformedDataException.idl> 44*b1cdbd2cSJim Jagielski#endif 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski//============================================================================= 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module configuration { module backend { 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski//============================================================================= 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski/** 53*b1cdbd2cSJim Jagielski Handles access to the elements of a component schema, 54*b1cdbd2cSJim Jagielski i.e its templates and its component definition. 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski @since OpenOffice 1.1.2 57*b1cdbd2cSJim Jagielski*/ 58*b1cdbd2cSJim Jagielskipublished interface XSchema : ::com::sun::star::uno::XInterface 59*b1cdbd2cSJim Jagielski{ 60*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski /** 63*b1cdbd2cSJim Jagielski Describes the full schema (templates + component) to a 64*b1cdbd2cSJim Jagielski <type>XSchemaHandler</type>. 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski @param aHandler 67*b1cdbd2cSJim Jagielski schema handler that will receive calls 68*b1cdbd2cSJim Jagielski describing the contents of the templates 69*b1cdbd2cSJim Jagielski and the component definition 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::NullPointerException 72*b1cdbd2cSJim Jagielski if a <NULL/> handler is passed. 73*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::WrappedTargetException 74*b1cdbd2cSJim Jagielski if an error occurs in the access to or processing of the data or 75*b1cdbd2cSJim Jagielski if a subsequent call to any of the <type>XSchema</type>methods is made. 76*b1cdbd2cSJim Jagielski The elements of a component schema are only parsed once,a repeat call 77*b1cdbd2cSJim Jagielski leads to exception. 78*b1cdbd2cSJim Jagielski @throws com::sun::star::configuration::backend::MalformedDataException 79*b1cdbd2cSJim Jagielski if the data read from the layer is rejected as invalid by the 80*b1cdbd2cSJim Jagielski <type>XSchemaHandler</type>. 81*b1cdbd2cSJim Jagielski */ 82*b1cdbd2cSJim Jagielski void readSchema([in] XSchemaHandler aHandler) 83*b1cdbd2cSJim Jagielski raises (com::sun::star::lang::NullPointerException, 84*b1cdbd2cSJim Jagielski com::sun::star::lang::WrappedTargetException, 85*b1cdbd2cSJim Jagielski MalformedDataException) ; 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski /** 90*b1cdbd2cSJim Jagielski Describes only the component definition to a <type>XSchemaHandler</type>. 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski @param aHandler 93*b1cdbd2cSJim Jagielski schema handler that will receive calls 94*b1cdbd2cSJim Jagielski describing the contents of the component 95*b1cdbd2cSJim Jagielski definition 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::NullPointerException 98*b1cdbd2cSJim Jagielski if a <NULL/> handler is passed. 99*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::WrappedTargetException 100*b1cdbd2cSJim Jagielski if an error occurs in the access to or processing of the data or 101*b1cdbd2cSJim Jagielski if a subsequent call to any of the <type>XSchema</type>methods is made. 102*b1cdbd2cSJim Jagielski The elements of a component schema are only parsed once,a repeat call 103*b1cdbd2cSJim Jagielski leads to exception. 104*b1cdbd2cSJim Jagielski @throws com::sun::star::configuration::backend::MalformedDataException 105*b1cdbd2cSJim Jagielski if the data read from the layer is rejected as invalid by the 106*b1cdbd2cSJim Jagielski <type>XSchemaHandler</type>. 107*b1cdbd2cSJim Jagielski */ 108*b1cdbd2cSJim Jagielski void readComponent([in] XSchemaHandler aHandler) 109*b1cdbd2cSJim Jagielski raises (com::sun::star::lang::NullPointerException, 110*b1cdbd2cSJim Jagielski com::sun::star::lang::WrappedTargetException, 111*b1cdbd2cSJim Jagielski MalformedDataException) ; 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 114*b1cdbd2cSJim Jagielski 115*b1cdbd2cSJim Jagielski /** 116*b1cdbd2cSJim Jagielski Describes the component templates to a <type>XSchemaHandler</type>. 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski @param aHandler 119*b1cdbd2cSJim Jagielski schema handler that will receive calls 120*b1cdbd2cSJim Jagielski describing the contents of the templates 121*b1cdbd2cSJim Jagielski 122*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::NullPointerException 123*b1cdbd2cSJim Jagielski if a <NULL/> handler is passed. 124*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::WrappedTargetException 125*b1cdbd2cSJim Jagielski if an error occurs in the access to or processing of the data or 126*b1cdbd2cSJim Jagielski if a subsequent call to any of the <type>XSchema</type>methods is made. 127*b1cdbd2cSJim Jagielski The elements of a component schema are only parsed once,a repeat call 128*b1cdbd2cSJim Jagielski leads to exception. 129*b1cdbd2cSJim Jagielski @throws com::sun::star::configuration::backend::MalformedDataException 130*b1cdbd2cSJim Jagielski if the data read from the layer is rejected as invalid by the 131*b1cdbd2cSJim Jagielski <type>XSchemaHandler</type>. 132*b1cdbd2cSJim Jagielski */ 133*b1cdbd2cSJim Jagielski void readTemplates([in] XSchemaHandler aHandler) 134*b1cdbd2cSJim Jagielski raises (com::sun::star::lang::NullPointerException, 135*b1cdbd2cSJim Jagielski com::sun::star::lang::WrappedTargetException, 136*b1cdbd2cSJim Jagielski MalformedDataException) ; 137*b1cdbd2cSJim Jagielski 138*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 139*b1cdbd2cSJim Jagielski} ; 140*b1cdbd2cSJim Jagielski 141*b1cdbd2cSJim Jagielski//============================================================================= 142*b1cdbd2cSJim Jagielski 143*b1cdbd2cSJim Jagielski} ; } ; } ; } ; } ; 144*b1cdbd2cSJim Jagielski#endif 145