/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_text_fieldmaster_Database_idl_
#define __com_sun_star_text_fieldmaster_Database_idl_

#include <com/sun/star/text/TextFieldMaster.idl>
#include <com/sun/star/beans/PropertyValues.idl>


module com { module sun { module star { module text { module fieldmaster {

/** specifies service of a Database field master.
    @see com::sun::star::text::TextField

    Only one of the properties #DataBaseName,
    #DataBaseURL and #DataBaseResource
    should be set. If more than one are set the last one will be used.
*/
published service Database
{
    service  com::sun::star::text::TextFieldMaster;

    /** specifies the database name.
     */
    [property] string DataBaseName;

    /** contains the CommandType this
     can be the name of a data base table, a data query or a statement.
     (0 = table, 1 = query, 2 = statement)
     */
    [property] long CommandType;
    /** contains the command string. Depending on the CommandType property this
     can be the name of a data base table, a data query or a statement.
     */
    [property] string DataTableName;
    /** contains the name of the data base table.
     */
    [property] string DataColumnName;

    /** indicates the URL of a database file.
        @since OOo 2.0
     */
    [optional, property] string DataBaseURL;

    /** indicates a connection URL, which locates a database driver.
        @since OOo 2.0
     */
    [optional, property] string DataBaseResource;
    /** contains the DataColumnName but it enables the fieldmaster and its
        depending fields to work without setting DataSourceName, DataTableName and CommandType
        @since OOo 2.3
     */
    [optional, property] string Name;

};


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
