offapi/com/sun/star/configuration/backend/XBackend.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: XBackend.idl,v $
  10  * $Revision: 1.6 $
  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_XBackend_idl__
  31 #define __com_sun_star_configuration_backend_XBackend_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_configuration_backend_XUpdateHandler_idl__
  38 #include <com/sun/star/configuration/backend/XUpdateHandler.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_configuration_backend_XLayer_idl__
  42 #include <com/sun/star/configuration/backend/XLayer.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_configuration_backend_XSchema_idl__
  46 #include <com/sun/star/configuration/backend/XSchema.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__
  50 #include <com/sun/star/configuration/backend/BackendAccessException.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  54 #include <com/sun/star/lang/IllegalArgumentException.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_lang_NoSupportException_idl__
  58 #include <com/sun/star/lang/NoSupportException.idl>
  59 #endif
  60
  61 //=============================================================================
  62
  63 module com { module sun { module star { module configuration { module backend {
  64
  65 //=============================================================================
  66
  67 /**
  68   Handles access to layered data stored in a repository.
  69
  70   <p> Data can be retrieved on behalf of one or more entities.</p>
  71
  72   <p> There is an implied owner entity associated to the object
  73      when it is created. This entity should be used for normal data access.
  74      For administrative operations data of other entities can be accessed.
  75   </p>
  76
  77   @see com::sun::star::configuration::backend::XBackendEntities
  78   @see com::sun::star::configuration::backend::XSchemaSupplier
  79
  80   @since OOo 1.1.2
  81 */
  82 published interface XBackend : ::com::sun::star::uno::XInterface
  83 {
  84     //-------------------------------------------------------------------------
  85
  86     /**
  87       retrieves the layers associated to the owner
  88       entity for a component.
  89
  90       @param aComponent
  91                 component whose data will be accessed
  92
  93       @returns
  94                 a list of objects allowing access to the
  95                 component data for each layer associated to
  96                 the current entity
  97
  98       @throws   com::sun::star::lang::IllegalArgumentException
  99                 if the component identifier is invalid
 100
 101       @throws   com::sun::star::configuration::backend::BackendAccessException
 102                 if an error occurs while accessing the data.
 103
 104       @see com::sun::star::configuration::backend::XBackendEntities::getOwnerEntity()
 105     */
 106     sequence<XLayer> listOwnLayers([in] string aComponent)
 107         raises (BackendAccessException,
 108                 com::sun::star::lang::IllegalArgumentException) ;
 109
 110     //-------------------------------------------------------------------------
 111
 112     /**
 113       creates an update handler for the owner entity
 114       layer for a component.
 115
 116       @param aComponent
 117                 component whose data will be updated
 118
 119       @returns
 120                 an object allowing manipulation of the
 121                 component data for the current entity
 122
 123       @throws   com::sun::star::lang::IllegalArgumentException
 124                 if the component identifier is invalid
 125
 126       @throws   com::sun::star::lang::NoSupportException
 127                 if updates are not supported for this backend
 128
 129       @throws   com::sun::star::configuration::backend::BackendAccessException
 130                 if an error occurs while accessing the data.
 131
 132       @see com::sun::star::configuration::backend::XBackendEntities::getOwnerEntity()
 133     */
 134     XUpdateHandler getOwnUpdateHandler([in] string aComponent)
 135         raises (BackendAccessException,
 136                 com::sun::star::lang::NoSupportException,
 137                 com::sun::star::lang::IllegalArgumentException) ;
 138
 139     //-------------------------------------------------------------------------
 140
 141     /**
 142       retrieves the layers associated to an entity for a component.
 143
 144       @param aComponent
 145                 component whose data will be accessed
 146
 147       @param aEntity
 148                 entity whose data will be accessed
 149
 150       @returns
 151                 a list of objects allowing access to the
 152                 component data for each layer associated
 153                 with the entity.
 154
 155       @throws   com::sun::star::lang::IllegalArgumentException
 156                 if the component identifier is invalid
 157                 or if the entity doesn't exist.
 158
 159       @throws   com::sun::star::configuration::backend::BackendAccessException
 160                 if an error occurs while accessing the data.
 161
 162       @see com::sun::star::configuration::backend::XBackendEntities::supportsEntity()
 163     */
 164     sequence<XLayer> listLayers([in] string aComponent,
 165                                 [in] string aEntity)
 166         raises (BackendAccessException,
 167                 com::sun::star::lang::IllegalArgumentException) ;
 168
 169     //-------------------------------------------------------------------------
 170
 171     /**
 172       creates an update handler on an entity's layer for a component.
 173
 174       @param aComponent
 175                 component whose data will be updated
 176
 177       @param aEntity
 178                 entity whose data will be updated
 179
 180       @returns
 181                 an object allowing manipulation of the
 182                 component data for the entity
 183
 184       @throws   com::sun::star::lang::IllegalArgumentException
 185                 if the component identifier is invalid
 186                 or if the entity doesn't exist.
 187
 188       @throws   com::sun::star::lang::NoSupportException
 189                 if updates are not supported for this backend
 190
 191       @throws   com::sun::star::configuration::backend::BackendAccessException
 192                 if an error occurs while accessing the data.
 193
 194       @see com::sun::star::configuration::backend::XBackendEntities::supportsEntity()
 195     */
 196     XUpdateHandler getUpdateHandler([in] string aComponent,
 197                                     [in] string aEntity)
 198         raises (BackendAccessException,
 199                 com::sun::star::lang::NoSupportException,
 200                 com::sun::star::lang::IllegalArgumentException) ;
 201
 202     //-------------------------------------------------------------------------
 203 } ;
 204
 205 //=============================================================================
 206
 207 } ; } ; } ; } ; } ;
 208
 209 #endif