1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_XBackendEntities_idl__ 24cdf0e10cSrcweir#define __com_sun_star_configuration_backend_XBackendEntities_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 31cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__ 34cdf0e10cSrcweir#include <com/sun/star/configuration/backend/BackendAccessException.idl> 35cdf0e10cSrcweir#endif 36cdf0e10cSrcweir 37cdf0e10cSrcweir//============================================================================= 38cdf0e10cSrcweir 39cdf0e10cSrcweirmodule com { module sun { module star { module configuration { module backend { 40cdf0e10cSrcweir 41cdf0e10cSrcweir//============================================================================= 42cdf0e10cSrcweir 43cdf0e10cSrcweir/** 44cdf0e10cSrcweir Provides functionality relating to common and supported entities 45cdf0e10cSrcweir for a configuration data backend. 46cdf0e10cSrcweir 47cdf0e10cSrcweir @see com::sun::star::configuration::backend::XBackend 48cdf0e10cSrcweir @see com::sun::star::configuration::backend::XMultiLayerStratum 49cdf0e10cSrcweir 50*0d3a54ffSJürgen Schmidt @since OpenOffice 1.1.2 51cdf0e10cSrcweir*/ 52cdf0e10cSrcweirpublished interface XBackendEntities : ::com::sun::star::uno::XInterface 53cdf0e10cSrcweir{ 54cdf0e10cSrcweir //------------------------------------------------------------------------- 55cdf0e10cSrcweir 56cdf0e10cSrcweir /** 57cdf0e10cSrcweir provides the entity id of the owner entity of the backend. 58cdf0e10cSrcweir 59cdf0e10cSrcweir @returns 60cdf0e10cSrcweir an entity identifier for the owner entity. 61cdf0e10cSrcweir <p> The owner entity is the default entity for the backend. 62cdf0e10cSrcweir For normal configuration data access the owner entity 63cdf0e10cSrcweir should always be used. 64cdf0e10cSrcweir </p> 65cdf0e10cSrcweir 66cdf0e10cSrcweir @see com::sun::star::configuration::backend::XBackend::listOwnLayers() 67cdf0e10cSrcweir @see com::sun::star::configuration::backend::XBackend::getOwnUpdateHandler() 68cdf0e10cSrcweir */ 69cdf0e10cSrcweir string getOwnerEntity() ; 70cdf0e10cSrcweir 71cdf0e10cSrcweir //------------------------------------------------------------------------- 72cdf0e10cSrcweir 73cdf0e10cSrcweir /** 74cdf0e10cSrcweir provides the entity id of an entity for general administrative access. 75cdf0e10cSrcweir 76cdf0e10cSrcweir <p> The admin entity is an entity that should be used to 77cdf0e10cSrcweir read and manage configuration data that applies to all entities 78cdf0e10cSrcweir within the backend. 79cdf0e10cSrcweir </p> 80cdf0e10cSrcweir 81cdf0e10cSrcweir @returns 82cdf0e10cSrcweir an entity identifier for the admin entity or 83cdf0e10cSrcweir an empty string, if there is no entity that can be used for 84cdf0e10cSrcweir general administrative access. 85cdf0e10cSrcweir 86cdf0e10cSrcweir */ 87cdf0e10cSrcweir string getAdminEntity() ; 88cdf0e10cSrcweir 89cdf0e10cSrcweir //------------------------------------------------------------------------- 90cdf0e10cSrcweir 91cdf0e10cSrcweir /** 92cdf0e10cSrcweir determines, if a given entity id exists in this backend. 93cdf0e10cSrcweir 94cdf0e10cSrcweir @param aEntity 95cdf0e10cSrcweir The name of an entity. 96cdf0e10cSrcweir 97cdf0e10cSrcweir @throws com::sun::star::configuration::backend::BackendAccessException 98cdf0e10cSrcweir if an error occurs while accessing the backend. 99cdf0e10cSrcweir 100cdf0e10cSrcweir @returns 101cdf0e10cSrcweir <TRUE/>, if aEntity is a valid, existing entity for this backend, 102cdf0e10cSrcweir <FALSE/> otherwise. 103cdf0e10cSrcweir */ 104cdf0e10cSrcweir boolean supportsEntity([in] string aEntity) 105cdf0e10cSrcweir raises( BackendAccessException ); 106cdf0e10cSrcweir 107cdf0e10cSrcweir //------------------------------------------------------------------------- 108cdf0e10cSrcweir 109cdf0e10cSrcweir /** 110cdf0e10cSrcweir determines, if two given entity ids denote the same entity. 111cdf0e10cSrcweir 112cdf0e10cSrcweir @param aEntity 113cdf0e10cSrcweir The name of an entity. 114cdf0e10cSrcweir 115cdf0e10cSrcweir @param aOtherEntity 116cdf0e10cSrcweir The name of another entity. 117cdf0e10cSrcweir 118cdf0e10cSrcweir @returns 119cdf0e10cSrcweir <TRUE/>, if aEntity and aOtherEntity denote the same entity 120cdf0e10cSrcweir within this backend, <FALSE/> otherwise. 121cdf0e10cSrcweir 122cdf0e10cSrcweir @throws com::sun::star::configuration::backend::BackendAccessException 123cdf0e10cSrcweir if an error occurs while accessing the backend. 124cdf0e10cSrcweir 125cdf0e10cSrcweir @throws com::sun::star::lang::IllegalArgumentException 126cdf0e10cSrcweir if either entity does not exist. 127cdf0e10cSrcweir */ 128cdf0e10cSrcweir boolean isEqualEntity([in] string aEntity, [in] string aOtherEntity) 129cdf0e10cSrcweir raises( BackendAccessException, com::sun::star::lang::IllegalArgumentException) ; 130cdf0e10cSrcweir 131cdf0e10cSrcweir //------------------------------------------------------------------------- 132cdf0e10cSrcweir} ; 133cdf0e10cSrcweir 134cdf0e10cSrcweir//============================================================================= 135cdf0e10cSrcweir 136cdf0e10cSrcweir} ; } ; } ; } ; } ; 137cdf0e10cSrcweir 138cdf0e10cSrcweir#endif 139