offapi/com/sun/star/configuration/backend/XVersionedSchemaSupplier.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: XVersionedSchemaSupplier.idl,v $
  10  * $Revision: 1.4 $
  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_XVersionedSchemaSupplier_idl__
  31 #define __com_sun_star_configuration_backend_XVersionedSchemaSupplier_idl__
  32
  33 #ifndef __com_sun_star_configuration_backend_XSchemaSupplier_idl__
  34 #include <com/sun/star/configuration/backend/XSchemaSupplier.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__
  38 #include <com/sun/star/configuration/backend/BackendAccessException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  42 #include <com/sun/star/lang/IllegalArgumentException.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com { module sun { module star { module configuration { module backend {
  48
  49 //=============================================================================
  50
  51 /**
  52   provides access to versioned configuration component schemas.
  53
  54   @since OOo 2.0
  55 */
  56 interface XVersionedSchemaSupplier : XSchemaSupplier
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     /**
  61       Returns the schema version for a particular component.
  62
  63       @param aComponent
  64                 component whose schema version will be determined
  65
  66       @returns
  67                 a <atom>string</atom> that identifies the schema version for
  68                 the given component.
  69
  70                 <p> The format of the version string is arbitrary. No meaning
  71                 should be attached to it, unless an implementing service
  72                 defines one. If no version can be determined, an empty
  73                 <atom>string</atom> may be returned.
  74                 </p>
  75
  76                 <p> Clients may assume that all instances of a schema with the
  77                 same version are identical. The converse is not true.
  78                 In particular an implementation may return the same version
  79                 string for all schemas it supplies (i.e. return a version for
  80                 the complete schema, including all components)
  81                 </p>
  82
  83       @throws   com::sun::star::lang::IllegalArgumentException
  84                 if the component identifier is invalid.
  85
  86       @throws   com::sun::star::configuration::backend::BackendAccessException
  87                 if an error occurs while accessing the version data.
  88     */
  89     string getSchemaVersion([in] string aComponent)
  90         raises (BackendAccessException,
  91                 com::sun::star::lang::IllegalArgumentException) ;
  92
  93     //-------------------------------------------------------------------------
  94 } ;
  95
  96 //=============================================================================
  97
  98 } ; } ; } ; } ; } ;
  99
 100 #endif