1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_configuration_backend_XSchemaSupplier_idl__
24#define __com_sun_star_configuration_backend_XSchemaSupplier_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_configuration_backend_XSchema_idl__
31#include <com/sun/star/configuration/backend/XSchema.idl>
32#endif
33
34#ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__
35#include <com/sun/star/configuration/backend/BackendAccessException.idl>
36#endif
37
38#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
39#include <com/sun/star/lang/IllegalArgumentException.idl>
40#endif
41
42//=============================================================================
43
44module com { module sun { module star { module configuration { module backend {
45
46//=============================================================================
47
48/**
49  provides access to configuration component schemas.
50
51  @since OpenOffice 1.1.2
52*/
53published interface XSchemaSupplier : ::com::sun::star::uno::XInterface
54{
55	//-------------------------------------------------------------------------
56
57    /**
58      Returns the schema information (component + templates)
59      for a particular component.
60
61      @param aComponent
62                component whose schema will be accessed
63
64      @returns
65                an object allowing access to the various parts of the schema,
66                <NULL/> if the component doesn't exist.
67
68      @throws   com::sun::star::lang::IllegalArgumentException
69                if the component identifier is invalid.
70
71      @throws   com::sun::star::configuration::backend::BackendAccessException
72                if an error occurs while accessing the data.
73	*/
74    XSchema getComponentSchema([in] string aComponent)
75        raises (BackendAccessException,
76                com::sun::star::lang::IllegalArgumentException) ;
77
78	//-------------------------------------------------------------------------
79} ;
80
81//=============================================================================
82
83} ; } ; } ; } ; } ;
84
85#endif
86