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