offapi/com/sun/star/text/MailMerge.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: MailMerge.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_text_MailMerge_idl__
  31 #define __com_sun_star_text_MailMerge_idl__
  32
  33 #ifndef __com_sun_star_task_XJob_idl__
  34 #include <com/sun/star/task/XJob.idl>
  35 #endif
  36 #ifndef __com_sun_star_sdbc_XResultSet_idl__
  37 #include <com/sun/star/sdbc/XResultSet.idl>
  38 #endif
  39 #ifndef __com_sun_star_sdbc_XConnection_idl__
  40 #include <com/sun/star/sdbc/XConnection.idl>
  41 #endif
  42 #ifndef __com_sun_star_frame_XModel_idl__
  43 #include <com/sun/star/frame/XModel.idl>
  44 #endif
  45 #ifndef __com_sun_star_beans_XPropertySet_idl__
  46 #include <com/sun/star/beans/XPropertySet.idl>
  47 #endif
  48 #ifndef __com_sun_star_text_XMailMergeBroadcaster_idl__
  49 #include <com/sun/star/text/XMailMergeBroadcaster.idl>
  50 #endif
  51 #ifndef __com_sun_star_sdb_DataAccessDescriptor_idl__
  52 #include <com/sun/star/sdb/DataAccessDescriptor.idl>
  53 #endif
  54
  55 //=============================================================================
  56
  57  module com {  module sun {  module star {  module text {
  58
  59 //=============================================================================
  60
  61 /** Gives access to mail merge functionality.
  62
  63     @since OOo 1.1.2
  64  */
  65 published service MailMerge
  66 {
  67     /** interface to execute the mail merge action.
  68
  69         <p>The <member scope="com::sun::star::task">XJob::execute</member>
  70         method of the interface accepts exactly the same properties
  71         as provided by this service in its argument sequence.</p>
  72
  73         <p>The default values for the properties to be used in the method
  74         call are those given by this service. If a property is also listed
  75         in the argument sequence that value will be used for the call.
  76         The value of the property in this service will remain unchanged
  77         by that.</p>
  78      */
  79     interface com::sun::star::task::XJob;
  80
  81     /** interface to access the services properties.
  82      */
  83     interface com::sun::star::beans::XPropertySet;
  84
  85     /** interface to notify mail merge listeners.
  86      */
  87     [optional] interface com::sun::star::text::XMailMergeBroadcaster;
  88
  89     //=============================================================================
  90
  91     /* database properties */
  92
  93     //=============================================================================
  94     /** allows to specify the data which the mail merge should be based on.
  95
  96         <p>This service describe the interaction between all data access related properties,
  97         namely <member>DataSourceName</member>, <member>Command</member>, <member>CommandType</member>,
  98         <member>Connection</member>, <member>Selection</member>, <member>ResultSet</member>,
  99         <member>Filter</member> and <member>EscapeProcessing</member>
 100     */
 101     service com::sun::star::sdb::DataAccessDescriptor;
 102
 103     /** contains the name of the data source that is to be used for merging.
 104
 105         <p>For the interaction of this property with other data access relevant properties, see
 106         the <type scope="com::sun::star::sdb">DataAccessDescriptor</type> service.</p>
 107      */
 108     [property] string DataSourceName;
 109
 110     //=============================================================================
 111
 112     /** determines the type of the database command as
 113         described in <type scope="com::sun::star::sdb">CommandType</type>
 114
 115         <p>For the interaction of this property with other data access relevant properties, see
 116         the <type scope="com::sun::star::sdb">DataAccessDescriptor</type> service.</p>
 117      */
 118     [property] long CommandType;
 119
 120     //=============================================================================
 121
 122     /** contains the database command.
 123
 124         <p>For the interaction of this property with other data access relevant properties, see
 125         the <type scope="com::sun::star::sdb">DataAccessDescriptor</type> service.</p>
 126      */
 127     [property] string Command;
 128
 129     //=============================================================================
 130
 131     /** provides access to a
 132         <type scope="com::sun::star::sdbc">XResultSet</type> of
 133         a <type scope="com::sun::star::sdbc">ResultSet</type> service.
 134
 135         <p>Note that any superservices of <type scope="com::sun::star::sdbc">ResultSet</type>
 136         are also allowed. Especially, this member can denote an instance of the
 137         <type scope="com::sun::star::sdb">RowSet</type>, or an instance obtained
 138         by calling <member scope="com::sun::star::sdb">XResultSetAccess::createResultSet</member>
 139         on such a <type scope="com::sun::star::sdb">RowSet</type>. This becomes important in
 140         conjunction with the <member>Selection</member> property.</p>
 141
 142         <p>For the interaction of this property with other data access relevant properties, see
 143         the <type scope="com::sun::star::sdb">DataAccessDescriptor</type> service.</p>
 144      */
 145     [property] com::sun::star::sdbc::XResultSet ResultSet;
 146
 147     //=============================================================================
 148
 149     /** contains the connection to the database.
 150
 151         <p>For the interaction of this property with other data access relevant properties, see
 152         the <type scope="com::sun::star::sdb">DataAccessDescriptor</type> service.</p>
 153      */
 154     [property] com::sun::star::sdbc::XConnection ActiveConnection;
 155
 156     //=============================================================================
 157
 158     /** contains a selection that refers to bookmarks of the ResultSet.
 159
 160         <p>This property is relevant in conjunction with the <member>ResultSet</member>
 161         only. A single element of this array describes a bookmark relative to the result set.<br/>
 162         Note that this implies that the <member>ResultSet</member> needs to support the
 163         <type scope="com::sun::star::sdbcx">XRowLocate</type> interface.</p>
 164
 165         <p>If this array is empty, the whole result set, as described by <member>ResultSet</member>
 166         respectively the triple (<member>DataSourceName</member>, <member>DataCommandType</member>,
 167         <member>DataCommand</member>).</p>
 168
 169         <p>For the interaction of this property with other data access relevant properties, see
 170         the <type scope="com::sun::star::sdb">DataAccessDescriptor</type> service.</p>
 171      */
 172     [property] sequence< any > Selection;
 173
 174     //=============================================================================
 175
 176     /** returns if escape processing is on or off.
 177
 178         <p>For the interaction of this property with other data access relevant properties, see
 179         the <type scope="com::sun::star::sdb">DataAccessDescriptor</type> service.</p>
 180      */
 181     [property] boolean EscapeProcessing;
 182
 183     //=============================================================================
 184
 185     /** contains a filter expression for an SQL statement.
 186
 187         <p>For the interaction of this property with other data access relevant properties, see
 188         the <type scope="com::sun::star::sdb">DataAccessDescriptor</type> service.</p>
 189      */
 190     [property] string Filter;
 191
 192     //=============================================================================
 193
 194     /* input properties */
 195
 196     //=============================================================================
 197
 198     /** contains the URL of a text document that is to be processed.
 199
 200         <p>If this property is not set an empty document is created.</p>
 201      */
 202     [property] string DocumentURL;
 203
 204     //=============================================================================
 205
 206     /** provides access to the model of the document to be processed.
 207
 208         <p>This property will automatically be set to the documents model
 209         if a document URL was set.</p>
 210      */
 211     [property, readonly] com::sun::star::frame::XModel Model;
 212
 213     //=============================================================================
 214
 215     /* output properties */
 216
 217     //=============================================================================
 218
 219     /** determines the destination of the mail merge action.
 220
 221         @see com::sun::star::text::MailMergeType
 222      */
 223     [property] short OutputType;
 224
 225     //=============================================================================
 226
 227     /** determines whether single print jobs will be generated per output document.
 228
 229         <p>This property is only evaluated for printer output.</p>
 230      */
 231     [property] boolean SinglePrintJobs;
 232
 233     //=============================================================================
 234
 235     /** contains the path where generated files are created.
 236
 237         <p>If "OutputURL" or "FileNamePrefix" are empty the missing value is
 238         generated from the location or title of the source documents.</p>
 239
 240         <p>This property is only evaluated for file output.</p>
 241      */
 242     [property] string OutputURL;
 243
 244     //=============================================================================
 245
 246     /** determines whether file names of created files are generated using
 247         the content of a database column.
 248
 249         <p>This property is only evaluated for file output.</p>
 250      */
 251     [property] boolean FileNameFromColumn;
 252
 253     //=============================================================================
 254
 255     /** contains the name of the column to generate the output file names.
 256
 257         <p>If FileNameFromColumn is true the content of the related column
 258         is added to the OutputURL.</p>
 259         <p>If "OutputURL" or "FileNamePrefix" are empty the missing value is
 260         generated from the location or title of the source documents.</p>
 261
 262         <p>This property is only evaluated for file output.</p>
 263      */
 264     [property] string FileNamePrefix;
 265
 266     //=============================================================================
 267
 268     /** Contains the password of the outgoing mail server. It is necessary to set this
 269         if the password is not already stored in the configuration for security reasons.
 270
 271         <p>This property is only evaluated for e-Mail output.</p>
 272
 273         @since OOo 2.0
 274     */
 275     [property, optional] string OutServerPassword;
 276     //=============================================================================
 277
 278     /** Contains the password of the incoming mail server. It is necessary to set this
 279         if the mail server configuration is set to 'SMTP after POP' authentication and
 280         the password is not already stored in the configuration for security reasons.
 281
 282         <p>This property is only evaluated for e-Mail output.</p>
 283
 284         @since OOo 2.0
 285     */
 286     [property, optional] string InServerPassword;
 287     //=============================================================================
 288
 289     /** contains the subject of the e-Mail message.
 290
 291         <p>This property is only evaluated for e-Mail output.</p>
 292         @since OOo 2.0
 293     */
 294     [property, optional] string Subject;
 295
 296     //=============================================================================
 297
 298     /** contains the name of the data base column that contains the e-Mail address
 299         to the e-Mail to.
 300
 301         <p>This property is only evaluated for e-Mail output.</p>
 302
 303         @since OOo 2.0
 304     */
 305     [property, optional] string AddressFromColumn;
 306
 307     //=============================================================================
 308
 309     /** determines that the created mail merge document is sent as body in HTML format.
 310         This property is only valid if the propery "SendAsAttachment" is set to <false/>.
 311
 312         <p>This property is only evaluated for e-Mail output.</p>
 313
 314         @since OOo 2.0
 315     */
 316     [property, optional] boolean SendAsHTML;
 317
 318     //=============================================================================
 319
 320
 321     /** determines that the created mail merge document is sent as attachment.
 322
 323         <p>This property is only evaluated for e-Mail output.</p>
 324
 325         @since OOo 2.0
 326     */
 327     [property, optional] boolean SendAsAttachment;
 328
 329     //=============================================================================
 330
 331     /** contains the text of the mail body.
 332         This property is only valid if the property "SendAsAttachment" is set to <true/>
 333         <p>This property is only evaluated for e-Mail output.</p>
 334
 335         @since OOo 2.0
 336     */
 337     [property, optional] string MailBody;
 338
 339     //=============================================================================
 340
 341     /** contains the name of the attachment.
 342         This property is only valid if "SendAsAttachment" is set to <true/>.
 343
 344         <p>This property is only evaluated for e-Mail output.</p>
 345
 346         @since OOo 2.0
 347     */
 348     [property, optional] string AttachmentName;
 349
 350     //=============================================================================
 351
 352     /** contains the name of the document filter to save the attached mail merge document.
 353         This property is only valid if "SendAsAttachment" is set to <true/>.
 354
 355         <p>This property is only evaluated for e-Mail output.</p>
 356
 357         @since OOo 2.0
 358     */
 359     [property, optional] string AttachmentFilter;
 360
 361     //=============================================================================
 362
 363     /** contains a list of e-Mail addresses to
 364         <p>This property is only evaluated for e-Mail output.</p>
 365
 366         @since OOo 2.0
 367     */
 368     [property, optional] sequence< string > CopiesTo;
 369
 370     //=============================================================================
 371
 372     /**
 373         <p>This property is only evaluated for e-Mail output.</p>
 374
 375         @since OOo 2.0
 376     */
 377     [property, optional] sequence< string > BlindCopiesTo;
 378
 379
 380     //=============================================================================
 381
 382     /** determines that the output of the mail merge is save in one single file.
 383         <p>This property is only evaluated for file output.</p>
 384
 385         @since OOo 2.0
 386     */
 387     [property, optional] boolean SaveAsSingleFile;
 388
 389     //=============================================================================
 390
 391     /** contains the name of the document filter to save the output file(s).
 392         <p>This property is only evaluated for file output.</p>
 393
 394         @since OOo 2.0
 395     */
 396     [property, optional] string SaveFilter;
 397
 398     //=============================================================================
 399
 400     /** contains the properties that are defined in <com::sun::star::view::PrintOptions>.
 401
 402         <p>This property is only evaluated for printer output.</p>
 403
 404         @since OOo 2.0
 405     */
 406     [property, optional] sequence< com::sun::star::beans::PropertyValue > PrintOptions;
 407
 408 };
 409
 410
 411 //=============================================================================
 412
 413 }; }; }; };
 414
 415 #endif