offapi/com/sun/star/sdb/DatabaseAccessContext.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: DatabaseAccessContext.idl,v $
  10  * $Revision: 1.11 $
  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_sdb_DatabaseAccessContext_idl__
  31 #define __com_sun_star_sdb_DatabaseAccessContext_idl__
  32
  33 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  34 #include <com/sun/star/container/XEnumerationAccess.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_container_XNameAccess_idl__
  38 #include <com/sun/star/container/XNameAccess.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_util_XLocalizedAliases_idl__
  42 #include <com/sun/star/util/XLocalizedAliases.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_lang_XLocalizable_idl__
  46 #include <com/sun/star/lang/XLocalizable.idl>
  47 #endif
  48
  49  module com {  module sun {  module star {  module sdb {
  50
  51 /** is the context for data access beans. It allows to register aliases for database
  52     access beans. It is possible to have different aliases for different locales.
  53
  54
  55     <p>
  56     A DatabaseContext stores an alias for the URL of a database access component
  57     for a given locale. It is also allowed to work with a default locale. This is useful
  58     in connection with Enumeration or NameAccess to the context. In common use, the
  59     default language is set during the initialization of the component.
  60     </p>
  61     <p>
  62     The service also provides a default handling for locales, where an alias isn't
  63     set. The first time an alias is registered for a programmatic name, the alias
  64     becomes the default for all other known locales.
  65
  66     </p>@see com::sun::star::util::XLocalizedAliases
  67
  68     @deprecated
  69  */
  70 published service DatabaseAccessContext
  71 {
  72     /** Enumeration on all registered data sources for a default locale.
  73      */
  74     interface com::sun::star::container::XEnumerationAccess;
  75
  76     /** NameAccess on all registered data sources for a default locale.
  77      */
  78     interface com::sun::star::container::XNameAccess;
  79
  80     /** Interface for registering aliases for data sources.
  81      */
  82     interface com::sun::star::util::XLocalizedAliases;
  83
  84     /** Interface for setting and retrieving the default language.
  85      */
  86     interface com::sun::star::lang::XLocalizable;
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 /*===========================================================================
  94 ===========================================================================*/
  95 #endif