xref: /AOO41X/main/offapi/com/sun/star/configuration/backend/Layer.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_configuration_backend_Layer_idl__
#define __com_sun_star_configuration_backend_Layer_idl__

#ifndef __com_sun_star_configuration_backend_XLayer_idl__
#include <com/sun/star/configuration/backend/XLayer.idl>
#endif

#ifndef __com_sun_star_configuration_backend_XCompositeLayer_idl__
#include <com/sun/star/configuration/backend/XCompositeLayer.idl>
#endif

#ifndef __com_sun_star_util_XTimeStamped_idl__
#include <com/sun/star/util/XTimeStamped.idl>
#endif

//==============================================================================

module com { module sun { module star { module configuration { module backend {

//==============================================================================

/**
  provides read-only access to a configuration data layer.

  <p> A layer contains the configuration setting changes to be performed
  on a default settings tree to obtain the values of those settings
  for a given entity and component.
  </p>

  @see com::sun::star::configuration::backend::Schema
        Service providing access to schema data for a configuration component.

  @see com::sun::star::configuration::backend::UpdatableLayer
        Service providing write access to a configuration data layer.

  @since OOo 1.1.2
  */
published service Layer
{
    //--------------------------------------------------------------------------

    /**
      provides read access to the contents of the configuration layer.
      */
    interface XLayer ;

    //--------------------------------------------------------------------------

    /**
      provides read access to sublayers accessible through an
      additional criterion (for instance the locale they contain data for).
      */
    [optional] interface XCompositeLayer ;

    //--------------------------------------------------------------------------

    /**
      provides a way to detect changes to the layer.

      <p> Timestamps should be considered as opaque markers and
      can only safely be compared for equality and
      only to timestamps generated by the same implementation.
      When the content of the Layer changes,
      the timestamp is guaranteed to change to a different value.
      </p>
      <p> The timestamp format depends on the implementation.
      If the timestamp is a representation of the time of the last change,
      the recommended format is "YYYYMMDDhhmmssZ".
      </p>
      */
    [optional] interface com::sun::star::util::XTimeStamped ;

    //--------------------------------------------------------------------------

    /**
      The URL of the layer data.

      @since OOo 2.0
      */
    [property,optional,readonly] string URL ;

    //--------------------------------------------------------------------------
} ;

//==============================================================================

} ; } ; } ; } ; } ;

#endif