/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_document_ExtendedTypeDetectionFactory_idl__
#define __com_sun_star_document_ExtendedTypeDetectionFactory_idl__

#include <com/sun/star/lang/XMultiServiceFactory.idl>
#include <com/sun/star/container/XNameContainer.idl>
#include <com/sun/star/container/XContainerQuery.idl>
#include <com/sun/star/util/XFlushable.idl>


module com { module sun { module star { module document {

/** factory to create extended type detection components.

    <p>
    This factory implements read/write access on the underlying configuration set.
    and further a validate and flush mechanism for more performance and a special query mode
    can be used here too.
    </p>

    @since OOo 1.1.2
 */
published service ExtendedTypeDetectionFactory
{
    /** factory interface to create and initialize extended type detection components.

        <p>
        A detection component must be specified by its UNO implementation name and will be created then.
        Every new created component can be initialized with its own configuration data
        and may given optional arguments of the corresponding createInstanceWithArguments() request. To do so the
        service must support the optional interface com::sun::star::lang::XInitialization.
        The arguments parameter will have the following structure:
        <ul>
            <li>sequence< Any >[0] contains a sequence< com::sun::star::beans::PropertyValue >,
                which represent the configuration data set of this detector component. The used properties are the same, as
                they are available at the container interface of this factory service. (see below)</li>
            <li>Every following item of the argument list sequence< Any >[1..n] contains the copied argument of the
                corresponding createInstanceWithArguments() call. That means: Item 0 or the original list was copied as
                item 1 of the destination list ... etc.
        </ul>
        </p>
     */
    interface com::sun::star::lang::XMultiServiceFactory;

    /** provides read access to the complete set of configuration data.

        <p>
        Every container item is specified as a set of properties and will be
        represented by a sequence< com::sun::star::beans::PropertyValue > structure.
        Follow properties are supported:
        (But note: not all of them must be present every time!)
        </p>
        <table border=1>
            <tr>
                <td><strong>Property Name</strong></td>
                <td><strong>Value Type</strong></td>
                <td><strong>Description</strong></td>
            </tr>
            <tr>
                <td><em>Name</em></td>
                <td>[string]</td>
                <td>It means the UNO implementation name of the detector component.
                    Note: It means the really the implementation instead of the UNO service name.
                    Because it's not possible to distinguish between more than one components; if all of them
                    uses a generic service identifier!</td>
            </tr>
            <tr>
                <td><em>Types</em></td>
                <td>[sequence< string >]</td>
                <td>It's a list of all types, which can be detected by this extended detection component.
                    All items of this list must match an item of the TypeDetection container service.</td>
            </tr>
        </table>
        </p>
     */
    interface com::sun::star::container::XNameAccess;

    /** provides a write access to the configuration data.
     */
    [optional] interface com::sun::star::container::XNameContainer;

    /** provides search on the configuration data set.

        <p>
        Against simple property search it provides some complex algorithms too.
        For further information please read the SDK documentation.
        </p>
     */
    [optional] interface com::sun::star::container::XContainerQuery;

    /** can be used to perform container changes.

        <p>
        Because the complexness of such configuration set can be very high,
        it seems not very useful to update the underlying configuration layer
        on every container change request immediately. Another strategy can be to
        make all changes (adding/changing/removing of items) and call flush at the end.
        That will validate the whole container and reject inconsistent data sets.
        Only in case all made changes was correct, they will be written back to the
        configuration. Further this interface provides the possibility, that interested
        changes listener can be registered too.
        </p>
     */
    [optional] interface com::sun::star::util::XFlushable;
};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */