LibreOffice LibreOffice 7.2 SDK API Reference

XBackendEntities.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef __com_sun_star_configuration_backend_XBackendEntities_idl__
20#define __com_sun_star_configuration_backend_XBackendEntities_idl__
21
22#include <com/sun/star/uno/XInterface.idl>
23#include <com/sun/star/lang/IllegalArgumentException.idl>
24#include <com/sun/star/configuration/backend/BackendAccessException.idl>
25
26
27module com { module sun { module star { module configuration { module backend {
28
29
39published interface XBackendEntities : ::com::sun::star::uno::XInterface
40{
41
55 string getOwnerEntity() ;
56
57
72 string getAdminEntity() ;
73
74
88 boolean supportsEntity([in] string aEntity)
89 raises( BackendAccessException );
90
91
111 boolean isEqualEntity([in] string aEntity, [in] string aOtherEntity)
112 raises( BackendAccessException, com::sun::star::lang::IllegalArgumentException) ;
113
114} ;
115
116
117} ; } ; } ; } ; } ;
118
119#endif
120
121/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
BackendAccessException.idl
IllegalArgumentException.idl
XInterface.idl
com::sun::star::configuration::backend::BackendAccessException
Generic exception thrown when physical access to an underlying backend fails.
Definition: BackendAccessException.idl:35
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
com::sun::star::configuration::backend::XBackendEntities
Provides functionality relating to common and supported entities for a configuration data backend.
Definition: XBackendEntities.idl:40
com::sun::star::configuration::backend::XBackendEntities::isEqualEntity
boolean isEqualEntity([in] string aEntity, [in] string aOtherEntity)
determines, if two given entity ids denote the same entity.
com::sun::star::configuration::backend::XBackendEntities::getOwnerEntity
string getOwnerEntity()
provides the entity id of the owner entity of the backend.
com::sun::star::configuration::backend::XBackendEntities::supportsEntity
boolean supportsEntity([in] string aEntity)
determines, if a given entity id exists in this backend.
com::sun::star::configuration::backend::XBackendEntities::getAdminEntity
string getAdminEntity()
provides the entity id of an entity for general administrative access.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com
Definition: Accessible.idl:22