/************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * Copyright 2008 by Sun Microsystems, Inc. * * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: XBackend.idl,v $ * $Revision: 1.6 $ * * This file is part of OpenOffice.org. * * OpenOffice.org is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License version 3 * only, as published by the Free Software Foundation. * * OpenOffice.org 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 version 3 for more details * (a copy is included in the LICENSE file that accompanied this code). * * You should have received a copy of the GNU Lesser General Public License * version 3 along with OpenOffice.org. If not, see * * for a copy of the LGPLv3 License. * ************************************************************************/ #ifndef __com_sun_star_configuration_backend_XBackend_idl__ #define __com_sun_star_configuration_backend_XBackend_idl__ #ifndef __com_sun_star_uno_XInterface_idl__ #include #endif #ifndef __com_sun_star_configuration_backend_XUpdateHandler_idl__ #include #endif #ifndef __com_sun_star_configuration_backend_XLayer_idl__ #include #endif #ifndef __com_sun_star_configuration_backend_XSchema_idl__ #include #endif #ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__ #include #endif #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ #include #endif #ifndef __com_sun_star_lang_NoSupportException_idl__ #include #endif //============================================================================= module com { module sun { module star { module configuration { module backend { //============================================================================= /** Handles access to layered data stored in a repository.

Data can be retrieved on behalf of one or more entities.

There is an implied owner entity associated to the object when it is created. This entity should be used for normal data access. For administrative operations data of other entities can be accessed.

@see com::sun::star::configuration::backend::XBackendEntities @see com::sun::star::configuration::backend::XSchemaSupplier @since OOo 1.1.2 */ published interface XBackend : ::com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** retrieves the layers associated to the owner entity for a component. @param aComponent component whose data will be accessed @returns a list of objects allowing access to the component data for each layer associated to the current entity @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 data. @see com::sun::star::configuration::backend::XBackendEntities::getOwnerEntity() */ sequence listOwnLayers([in] string aComponent) raises (BackendAccessException, com::sun::star::lang::IllegalArgumentException) ; //------------------------------------------------------------------------- /** creates an update handler for the owner entity layer for a component. @param aComponent component whose data will be updated @returns an object allowing manipulation of the component data for the current entity @throws com::sun::star::lang::IllegalArgumentException if the component identifier is invalid @throws com::sun::star::lang::NoSupportException if updates are not supported for this backend @throws com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the data. @see com::sun::star::configuration::backend::XBackendEntities::getOwnerEntity() */ XUpdateHandler getOwnUpdateHandler([in] string aComponent) raises (BackendAccessException, com::sun::star::lang::NoSupportException, com::sun::star::lang::IllegalArgumentException) ; //------------------------------------------------------------------------- /** retrieves the layers associated to an entity for a component. @param aComponent component whose data will be accessed @param aEntity entity whose data will be accessed @returns a list of objects allowing access to the component data for each layer associated with the entity. @throws com::sun::star::lang::IllegalArgumentException if the component identifier is invalid or if the entity doesn't exist. @throws com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the data. @see com::sun::star::configuration::backend::XBackendEntities::supportsEntity() */ sequence listLayers([in] string aComponent, [in] string aEntity) raises (BackendAccessException, com::sun::star::lang::IllegalArgumentException) ; //------------------------------------------------------------------------- /** creates an update handler on an entity's layer for a component. @param aComponent component whose data will be updated @param aEntity entity whose data will be updated @returns an object allowing manipulation of the component data for the entity @throws com::sun::star::lang::IllegalArgumentException if the component identifier is invalid or if the entity doesn't exist. @throws com::sun::star::lang::NoSupportException if updates are not supported for this backend @throws com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the data. @see com::sun::star::configuration::backend::XBackendEntities::supportsEntity() */ XUpdateHandler getUpdateHandler([in] string aComponent, [in] string aEntity) raises (BackendAccessException, com::sun::star::lang::NoSupportException, com::sun::star::lang::IllegalArgumentException) ; //------------------------------------------------------------------------- } ; //============================================================================= } ; } ; } ; } ; } ; #endif