offapi/com/sun/star/configuration/backend/XBackendEntities.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: XBackendEntities.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_XBackendEntities_idl__
  31 #define __com_sun_star_configuration_backend_XBackendEntities_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_lang_IllegalArgumentException_idl__
  38 #include <com/sun/star/lang/IllegalArgumentException.idl>
  39 #endif
  40 #ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__
  41 #include <com/sun/star/configuration/backend/BackendAccessException.idl>
  42 #endif
  43
  44 //=============================================================================
  45
  46 module com { module sun { module star { module configuration { module backend {
  47
  48 //=============================================================================
  49
  50 /**
  51   Provides functionality relating to common and supported entities
  52   for a configuration data backend.
  53
  54   @see com::sun::star::configuration::backend::XBackend
  55   @see com::sun::star::configuration::backend::XMultiLayerStratum
  56
  57   @since OOo 1.1.2
  58 */
  59 published interface XBackendEntities : ::com::sun::star::uno::XInterface
  60 {
  61     //-------------------------------------------------------------------------
  62
  63     /**
  64         provides the entity id of the owner entity of the backend.
  65
  66         @returns
  67             an entity identifier for the owner entity.
  68             <p> The owner entity is the default entity for the backend.
  69                For normal configuration data access the owner entity
  70                should always be used.
  71             </p>
  72
  73         @see com::sun::star::configuration::backend::XBackend::listOwnLayers()
  74         @see com::sun::star::configuration::backend::XBackend::getOwnUpdateHandler()
  75     */
  76     string getOwnerEntity() ;
  77
  78     //-------------------------------------------------------------------------
  79
  80     /**
  81         provides the entity id of an entity for general administrative access.
  82
  83         <p> The admin entity is an entity that should be used to
  84            read and manage configuration data that applies to all entities
  85            within the backend.
  86         </p>
  87
  88         @returns
  89             an entity identifier for the admin entity or
  90             an empty string, if there is no entity that can be used for
  91             general administrative access.
  92
  93     */
  94     string getAdminEntity() ;
  95
  96     //-------------------------------------------------------------------------
  97
  98     /**
  99         determines, if a given entity id exists in this backend.
 100
 101         @param aEntity
 102             The name of an entity.
 103
 104         @throws   com::sun::star::configuration::backend::BackendAccessException
 105                 if an error occurs while accessing the backend.
 106
 107         @returns
 108             <TRUE/>, if aEntity is a valid, existing entity for this backend,
 109             <FALSE/> otherwise.
 110     */
 111     boolean supportsEntity([in] string aEntity)
 112         raises( BackendAccessException );
 113
 114     //-------------------------------------------------------------------------
 115
 116     /**
 117         determines, if two given entity ids denote the same entity.
 118
 119         @param aEntity
 120             The name of an entity.
 121
 122         @param aOtherEntity
 123             The name of another entity.
 124
 125         @returns
 126             <TRUE/>, if aEntity and aOtherEntity denote the same entity
 127             within this backend, <FALSE/> otherwise.
 128
 129         @throws   com::sun::star::configuration::backend::BackendAccessException
 130                 if an error occurs while accessing the backend.
 131
 132         @throws   com::sun::star::lang::IllegalArgumentException
 133             if either entity does not exist.
 134     */
 135     boolean isEqualEntity([in] string aEntity, [in] string aOtherEntity)
 136         raises( BackendAccessException, com::sun::star::lang::IllegalArgumentException) ;
 137
 138     //-------------------------------------------------------------------------
 139 } ;
 140
 141 //=============================================================================
 142
 143 } ; } ; } ; } ; } ;
 144
 145 #endif