offapi/com/sun/star/configuration/backend/XSingleLayerStratum.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: XSingleLayerStratum.idl,v $
  10  * $Revision: 1.6 $
  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_configuration_backend_XSingleLayerStratum_idl__
  31 #define __com_sun_star_configuration_backend_XSingleLayerStratum_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_configuration_backend_XLayer_idl__
  38 #include <com/sun/star/configuration/backend/XLayer.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_configuration_backend_XUpdatableLayer_idl__
  42 #include <com/sun/star/configuration/backend/XUpdatableLayer.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__
  46 #include <com/sun/star/configuration/backend/BackendAccessException.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  50 #include <com/sun/star/lang/IllegalArgumentException.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_lang_NoSupportException_idl__
  54 #include <com/sun/star/lang/NoSupportException.idl>
  55 #endif
  56
  57 //=============================================================================
  58
  59 module com { module sun { module star { module configuration { module backend {
  60
  61 //=============================================================================
  62
  63 /**
  64   Handles access to a stratum consisting of a single layer
  65   in a configuration data repository
  66
  67   <p> The interface provides timestamp-checking capabilities
  68      for efficient caching.
  69   </p>
  70
  71   @see com::sun::star::util::XTimeStamped
  72   @see com::sun::star::configuration::backend::XSchemaSupplier
  73   @see com::sun::star::configuration::backend::XMultiLayerStratum
  74
  75   @since OOo 1.1.2
  76 */
  77 published interface XSingleLayerStratum : ::com::sun::star::uno::XInterface
  78 {
  79     //-------------------------------------------------------------------------
  80
  81     /**
  82         retrieves the layer data for a component, if newer than indicated.
  83
  84         <p> A timestamp can be provided, which is used to indicate
  85             a point in time. The layer should be returned only if is modified
  86             since that time.
  87         </p>
  88
  89         @param aComponent
  90                 The name of the component to access.
  91
  92         @param aTimestamp
  93                 a timestamp for the layer.
  94
  95                 <p> An empty timestamp indicates, that the layer should be
  96                     retrieved irrespective of its modification time.
  97                 </p>
  98                 <p> The format and meaning of a timestamp depends on
  99                     the implementation. Timestamps can be obtained using
 100                     <member scope="com::sun::star::util">XTimeStamped::getTimestamp()</member>.
 101                 </p>
 102
 103       @returns
 104                 a <type>Layer</type> object providing access to the layer data,
 105                 <NULL/> if the layer is newer than indicated by the timestamp.
 106
 107       @throws   com::sun::star::lang::IllegalArgumentException
 108                 if the component identifier is invalid or
 109                 if the timestamp is invalid.
 110
 111       @throws   com::sun::star::configuration::backend::BackendAccessException
 112                 if an error occurs while accessing the data.
 113
 114       @see com::sun::star::util::XTimeStamped
 115     */
 116     XLayer getLayer([in] string aComponent,
 117                     [in] string aTimestamp)
 118         raises (BackendAccessException,
 119                 com::sun::star::lang::IllegalArgumentException) ;
 120
 121     //-------------------------------------------------------------------------
 122
 123     /**
 124         retrieves a writable representation of the layer for a component.
 125
 126         @param aComponent
 127                 The name of the component to access.
 128
 129         @return
 130                 an <type>UpdatableLayer</type> object providing
 131                 write access to the layer
 132
 133         @throws   com::sun::star::lang::IllegalArgumentException
 134                 if the component identifier is invalid.
 135
 136         @throws   com::sun::star::lang::NoSupportException
 137                 if the implementation does not support updates.
 138
 139         @throws   com::sun::star::configuration::backend::BackendAccessException
 140                 if an error occurs while accessing the data.
 141      */
 142     XUpdatableLayer getUpdatableLayer([in] string aComponent)
 143         raises (BackendAccessException,
 144                 com::sun::star::lang::NoSupportException,
 145                 com::sun::star::lang::IllegalArgumentException) ;
 146
 147     //-------------------------------------------------------------------------
 148 } ;
 149
 150 //=============================================================================
 151
 152 } ; } ; } ; } ; } ;
 153
 154 #endif