1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_XSingleLayerStratum_idl__ 24cdf0e10cSrcweir#define __com_sun_star_configuration_backend_XSingleLayerStratum_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_XLayer_idl__ 31cdf0e10cSrcweir#include <com/sun/star/configuration/backend/XLayer.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_XUpdatableLayer_idl__ 35cdf0e10cSrcweir#include <com/sun/star/configuration/backend/XUpdatableLayer.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__ 39cdf0e10cSrcweir#include <com/sun/star/configuration/backend/BackendAccessException.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 43cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir 46cdf0e10cSrcweir#ifndef __com_sun_star_lang_NoSupportException_idl__ 47cdf0e10cSrcweir#include <com/sun/star/lang/NoSupportException.idl> 48cdf0e10cSrcweir#endif 49cdf0e10cSrcweir 50cdf0e10cSrcweir//============================================================================= 51cdf0e10cSrcweir 52cdf0e10cSrcweirmodule com { module sun { module star { module configuration { module backend { 53cdf0e10cSrcweir 54cdf0e10cSrcweir//============================================================================= 55cdf0e10cSrcweir 56cdf0e10cSrcweir/** 57cdf0e10cSrcweir Handles access to a stratum consisting of a single layer 58cdf0e10cSrcweir in a configuration data repository 59cdf0e10cSrcweir 60cdf0e10cSrcweir <p> The interface provides timestamp-checking capabilities 61cdf0e10cSrcweir for efficient caching. 62cdf0e10cSrcweir </p> 63cdf0e10cSrcweir 64cdf0e10cSrcweir @see com::sun::star::util::XTimeStamped 65cdf0e10cSrcweir @see com::sun::star::configuration::backend::XSchemaSupplier 66cdf0e10cSrcweir @see com::sun::star::configuration::backend::XMultiLayerStratum 67cdf0e10cSrcweir 68*0d3a54ffSJürgen Schmidt @since OpenOffice 1.1.2 69cdf0e10cSrcweir*/ 70cdf0e10cSrcweirpublished interface XSingleLayerStratum : ::com::sun::star::uno::XInterface 71cdf0e10cSrcweir{ 72cdf0e10cSrcweir //------------------------------------------------------------------------- 73cdf0e10cSrcweir 74cdf0e10cSrcweir /** 75cdf0e10cSrcweir retrieves the layer data for a component, if newer than indicated. 76cdf0e10cSrcweir 77cdf0e10cSrcweir <p> A timestamp can be provided, which is used to indicate 78cdf0e10cSrcweir a point in time. The layer should be returned only if is modified 79cdf0e10cSrcweir since that time. 80cdf0e10cSrcweir </p> 81cdf0e10cSrcweir 82cdf0e10cSrcweir @param aComponent 83cdf0e10cSrcweir The name of the component to access. 84cdf0e10cSrcweir 85cdf0e10cSrcweir @param aTimestamp 86cdf0e10cSrcweir a timestamp for the layer. 87cdf0e10cSrcweir 88cdf0e10cSrcweir <p> An empty timestamp indicates, that the layer should be 89cdf0e10cSrcweir retrieved irrespective of its modification time. 90cdf0e10cSrcweir </p> 91cdf0e10cSrcweir <p> The format and meaning of a timestamp depends on 92cdf0e10cSrcweir the implementation. Timestamps can be obtained using 93cdf0e10cSrcweir <member scope="com::sun::star::util">XTimeStamped::getTimestamp()</member>. 94cdf0e10cSrcweir </p> 95cdf0e10cSrcweir 96cdf0e10cSrcweir @returns 97cdf0e10cSrcweir a <type>Layer</type> object providing access to the layer data, 98cdf0e10cSrcweir <NULL/> if the layer is newer than indicated by the timestamp. 99cdf0e10cSrcweir 100cdf0e10cSrcweir @throws com::sun::star::lang::IllegalArgumentException 101cdf0e10cSrcweir if the component identifier is invalid or 102cdf0e10cSrcweir if the timestamp is invalid. 103cdf0e10cSrcweir 104cdf0e10cSrcweir @throws com::sun::star::configuration::backend::BackendAccessException 105cdf0e10cSrcweir if an error occurs while accessing the data. 106cdf0e10cSrcweir 107cdf0e10cSrcweir @see com::sun::star::util::XTimeStamped 108cdf0e10cSrcweir */ 109cdf0e10cSrcweir XLayer getLayer([in] string aComponent, 110cdf0e10cSrcweir [in] string aTimestamp) 111cdf0e10cSrcweir raises (BackendAccessException, 112cdf0e10cSrcweir com::sun::star::lang::IllegalArgumentException) ; 113cdf0e10cSrcweir 114cdf0e10cSrcweir //------------------------------------------------------------------------- 115cdf0e10cSrcweir 116cdf0e10cSrcweir /** 117cdf0e10cSrcweir retrieves a writable representation of the layer for a component. 118cdf0e10cSrcweir 119cdf0e10cSrcweir @param aComponent 120cdf0e10cSrcweir The name of the component to access. 121cdf0e10cSrcweir 122cdf0e10cSrcweir @return 123cdf0e10cSrcweir an <type>UpdatableLayer</type> object providing 124cdf0e10cSrcweir write access to the layer 125cdf0e10cSrcweir 126cdf0e10cSrcweir @throws com::sun::star::lang::IllegalArgumentException 127cdf0e10cSrcweir if the component identifier is invalid. 128cdf0e10cSrcweir 129cdf0e10cSrcweir @throws com::sun::star::lang::NoSupportException 130cdf0e10cSrcweir if the implementation does not support updates. 131cdf0e10cSrcweir 132cdf0e10cSrcweir @throws com::sun::star::configuration::backend::BackendAccessException 133cdf0e10cSrcweir if an error occurs while accessing the data. 134cdf0e10cSrcweir */ 135cdf0e10cSrcweir XUpdatableLayer getUpdatableLayer([in] string aComponent) 136cdf0e10cSrcweir raises (BackendAccessException, 137cdf0e10cSrcweir com::sun::star::lang::NoSupportException, 138cdf0e10cSrcweir com::sun::star::lang::IllegalArgumentException) ; 139cdf0e10cSrcweir 140cdf0e10cSrcweir //------------------------------------------------------------------------- 141cdf0e10cSrcweir} ; 142cdf0e10cSrcweir 143cdf0e10cSrcweir//============================================================================= 144cdf0e10cSrcweir 145cdf0e10cSrcweir} ; } ; } ; } ; } ; 146cdf0e10cSrcweir 147cdf0e10cSrcweir#endif 148