INTEGRATION: CWS nativefixer9 (1.1.2); FILE ADDED
2005/05/19 07:52:04 jb 1.1.2.1: #i49148# Add XVersionedSchemaSupplier, to support associating configuration schemas with version tags.
This commit is contained in:
Rüdiger Timm
parent
e59f0e7fc3
commit
934a1a6218
1 changed files with 131 additions and 0 deletions
|
|
@ -0,0 +1,131 @@
|
|||
/*************************************************************************
|
||||
*
|
||||
* $RCSfile: XVersionedSchemaSupplier.idl,v $
|
||||
*
|
||||
* $Revision: 1.2 $
|
||||
*
|
||||
* last change: $Author: rt $ $Date: 2005-05-20 15:46:16 $
|
||||
*
|
||||
* The Contents of this file are made available subject to the terms of
|
||||
* either of the following licenses
|
||||
*
|
||||
* - GNU Lesser General Public License Version 2.1
|
||||
* - Sun Industry Standards Source License Version 1.1
|
||||
*
|
||||
* Sun Microsystems Inc., October, 2000
|
||||
*
|
||||
* GNU Lesser General Public License Version 2.1
|
||||
* =============================================
|
||||
* Copyright 2000 by Sun Microsystems, Inc.
|
||||
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
||||
*
|
||||
* This library is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU Lesser General Public
|
||||
* License version 2.1, as published by the Free Software Foundation.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public
|
||||
* License along with this library; if not, write to the Free Software
|
||||
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
||||
* MA 02111-1307 USA
|
||||
*
|
||||
*
|
||||
* Sun Industry Standards Source License Version 1.1
|
||||
* =================================================
|
||||
* The contents of this file are subject to the Sun Industry Standards
|
||||
* Source License Version 1.1 (the "License"); You may not use this file
|
||||
* except in compliance with the License. You may obtain a copy of the
|
||||
* License at http://www.openoffice.org/license.html.
|
||||
*
|
||||
* Software provided under this License is provided on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
|
||||
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
|
||||
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
|
||||
* See the License for the specific provisions governing your rights and
|
||||
* obligations concerning the Software.
|
||||
*
|
||||
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
|
||||
*
|
||||
* Copyright: 2002 by Sun Microsystems, Inc.
|
||||
*
|
||||
* All Rights Reserved.
|
||||
*
|
||||
* Contributor(s): _______________________________________
|
||||
*
|
||||
*
|
||||
************************************************************************/
|
||||
#ifndef __com_sun_star_configuration_backend_XVersionedSchemaSupplier_idl__
|
||||
#define __com_sun_star_configuration_backend_XVersionedSchemaSupplier_idl__
|
||||
|
||||
#ifndef __com_sun_star_configuration_backend_XSchemaSupplier_idl__
|
||||
#include <com/sun/star/configuration/backend/XSchemaSupplier.idl>
|
||||
#endif
|
||||
|
||||
#ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__
|
||||
#include <com/sun/star/configuration/backend/BackendAccessException.idl>
|
||||
#endif
|
||||
|
||||
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
|
||||
#include <com/sun/star/lang/IllegalArgumentException.idl>
|
||||
#endif
|
||||
|
||||
//=============================================================================
|
||||
|
||||
module com { module sun { module star { module configuration { module backend {
|
||||
|
||||
//=============================================================================
|
||||
|
||||
/**
|
||||
provides access to versioned configuration component schemas.
|
||||
|
||||
@since OOo 2.0
|
||||
*/
|
||||
interface XVersionedSchemaSupplier : XSchemaSupplier
|
||||
{
|
||||
//-------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
Returns the schema version for a particular component.
|
||||
|
||||
@param aComponent
|
||||
component whose schema version will be determined
|
||||
|
||||
@returns
|
||||
a <atom>string</atom> that identifies the schema version for
|
||||
the given component.
|
||||
|
||||
<p> The format of the version string is arbitrary. No meaning
|
||||
should be attached to it, unless an implementing service
|
||||
defines one. If no version can be determined, an empty
|
||||
<atom>string</atom> may be returned.
|
||||
</p>
|
||||
|
||||
<p> Clients may assume that all instances of a schema with the
|
||||
same version are identical. The converse is not true.
|
||||
In particular an implementation may return the same version
|
||||
string for all schemas it supplies (i.e. return a version for
|
||||
the complete schema, including all components)
|
||||
</p>
|
||||
|
||||
@throws com::sun::star::lang::IllegalArgumentException
|
||||
if the component identifier is invalid.
|
||||
|
||||
@throws com::sun::star::configuration::backend::BackendAccessException
|
||||
if an error occurs while accessing the version data.
|
||||
*/
|
||||
string getSchemaVersion([in] string aComponent)
|
||||
raises (BackendAccessException,
|
||||
com::sun::star::lang::IllegalArgumentException) ;
|
||||
|
||||
//-------------------------------------------------------------------------
|
||||
} ;
|
||||
|
||||
//=============================================================================
|
||||
|
||||
} ; } ; } ; } ; } ;
|
||||
|
||||
#endif
|
||||
Loading…
Reference in a new issue