1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_XVersionedSchemaSupplier_idl__ 24cdf0e10cSrcweir#define __com_sun_star_configuration_backend_XVersionedSchemaSupplier_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_XSchemaSupplier_idl__ 27cdf0e10cSrcweir#include <com/sun/star/configuration/backend/XSchemaSupplier.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__ 31cdf0e10cSrcweir#include <com/sun/star/configuration/backend/BackendAccessException.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 35cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir//============================================================================= 39cdf0e10cSrcweir 40cdf0e10cSrcweirmodule com { module sun { module star { module configuration { module backend { 41cdf0e10cSrcweir 42cdf0e10cSrcweir//============================================================================= 43cdf0e10cSrcweir 44cdf0e10cSrcweir/** 45cdf0e10cSrcweir provides access to versioned configuration component schemas. 46cdf0e10cSrcweir 47cdf0e10cSrcweir @since OOo 2.0 48cdf0e10cSrcweir*/ 49cdf0e10cSrcweirinterface XVersionedSchemaSupplier : XSchemaSupplier 50cdf0e10cSrcweir{ 51cdf0e10cSrcweir //------------------------------------------------------------------------- 52cdf0e10cSrcweir 53cdf0e10cSrcweir /** 54cdf0e10cSrcweir Returns the schema version for a particular component. 55cdf0e10cSrcweir 56cdf0e10cSrcweir @param aComponent 57cdf0e10cSrcweir component whose schema version will be determined 58cdf0e10cSrcweir 59cdf0e10cSrcweir @returns 60cdf0e10cSrcweir a <atom>string</atom> that identifies the schema version for 61cdf0e10cSrcweir the given component. 62cdf0e10cSrcweir 63cdf0e10cSrcweir <p> The format of the version string is arbitrary. No meaning 64cdf0e10cSrcweir should be attached to it, unless an implementing service 65cdf0e10cSrcweir defines one. If no version can be determined, an empty 66cdf0e10cSrcweir <atom>string</atom> may be returned. 67cdf0e10cSrcweir </p> 68cdf0e10cSrcweir 69cdf0e10cSrcweir <p> Clients may assume that all instances of a schema with the 70cdf0e10cSrcweir same version are identical. The converse is not true. 71cdf0e10cSrcweir In particular an implementation may return the same version 72cdf0e10cSrcweir string for all schemas it supplies (i.e. return a version for 73cdf0e10cSrcweir the complete schema, including all components) 74cdf0e10cSrcweir </p> 75cdf0e10cSrcweir 76cdf0e10cSrcweir @throws com::sun::star::lang::IllegalArgumentException 77cdf0e10cSrcweir if the component identifier is invalid. 78cdf0e10cSrcweir 79cdf0e10cSrcweir @throws com::sun::star::configuration::backend::BackendAccessException 80cdf0e10cSrcweir if an error occurs while accessing the version data. 81cdf0e10cSrcweir */ 82cdf0e10cSrcweir string getSchemaVersion([in] string aComponent) 83cdf0e10cSrcweir raises (BackendAccessException, 84cdf0e10cSrcweir com::sun::star::lang::IllegalArgumentException) ; 85cdf0e10cSrcweir 86cdf0e10cSrcweir //------------------------------------------------------------------------- 87cdf0e10cSrcweir} ; 88cdf0e10cSrcweir 89cdf0e10cSrcweir//============================================================================= 90cdf0e10cSrcweir 91cdf0e10cSrcweir} ; } ; } ; } ; } ; 92cdf0e10cSrcweir 93cdf0e10cSrcweir#endif 94