offapi/com/sun/star/sync/XSyncCollector.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: XSyncCollector.idl,v $
  10  * $Revision: 1.8 $
  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
  31 #ifndef __com_sun_star_sync_XSyncCollector_idl__
  32 #define __com_sun_star_sync_XSyncCollector_idl__
  33
  34 #ifndef __com_sun_star_ucb_XContentProviderManager_idl__
  35 #include <com/sun/star/ucb/XContentProviderManager.idl>
  36 #endif
  37 #ifndef __com_sun_star_ucb_XContent_idl__
  38 #include <com/sun/star/ucb/XContent.idl>
  39 #endif
  40 #ifndef __com_sun_star_sync_SyncScheme_idl__
  41 #include <com/sun/star/sync/SyncScheme.idl>
  42 #endif
  43 #ifndef __com_sun_star_sync_SyncInfo_idl__
  44 #include <com/sun/star/sync/SyncInfo.idl>
  45 #endif
  46 #ifndef __com_sun_star_sync_SyncElement_idl__
  47 #include <com/sun/star/sync/SyncElement.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module sync {
  53
  54 /// @deprecated
  55 published interface XSyncCollector: com::sun::star::uno::XInterface
  56 {
  57     boolean                                                                                     initialize( [in] com::sun::star::ucb::XContentProviderManager xMgr,
  58                                                                 [in] sequence<com::sun::star::sync::SyncScheme> aSyncSchemes,
  59                                                                 [in] string aBaseFileName );
  60
  61     sequence<com::sun::star::sync::SyncScheme>          getRegisteredSyncSchemes();
  62
  63     sequence<com::sun::star::sync::SyncElement>         getSyncSequence( [in] string aSyncSchemeName,
  64                                                                      [in] com::sun::star::sync::SyncInfo aSyncInfo );
  65
  66     [oneway] void                                                                       beginSynchronize();
  67
  68     [oneway] void                                                                       endSynchronize();
  69
  70     boolean                                                                                     getCorrespondingElement( [in] com::sun::star::sync::SyncScheme aSyncSchemeIn,
  71                                                                              [in] com::sun::star::sync::SyncElement aSyncElementIn,
  72                                                                              [out] com::sun::star::sync::SyncElement aSyncElementOut );
  73
  74     boolean                                                                                     executeElementCommand( [in] string aSyncSchemeName,
  75                                                                            [in] com::sun::star::sync::SyncElement aSyncElement,
  76                                                                             [in] string aCommandName,
  77                                                                            [out] any aAny );
  78
  79     [oneway] void                                                                       elementSynchronized( [in] string aSyncSchemeName,
  80                                                                          [in] com::sun::star::sync::SyncElement aSyncElement,
  81                                                                          [in] unsigned long nSyncAction );
  82
  83     [oneway] void                                                                       notify( [in] com::sun::star::ucb::XContent XCnt,
  84                                                             [in] unsigned long nEvent );
  85 };
  86
  87 //=============================================================================
  88
  89 }; }; }; };
  90
  91 #endif