/*************************************************************************
 *
 * 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_util_XPropertyReplace_idl__
#define __com_sun_star_util_XPropertyReplace_idl__

#ifndef __com_sun_star_util_XReplaceDescriptor_idl__
#include <com/sun/star/util/XReplaceDescriptor.idl>
#endif

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif

#ifndef __com_sun_star_beans_UnknownPropertyException_idl__
#include <com/sun/star/beans/UnknownPropertyException.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif


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

module com {  module sun {  module star {  module util {

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

/** makes it possible to search and replace properties.
 */
published interface XPropertyReplace: com::sun::star::util::XReplaceDescriptor
{
    //-------------------------------------------------------------------------
    /** provides the information if specific property values are
        searched, or just the existence of the specified properties.
     */
    boolean getValueSearch();

    //-------------------------------------------------------------------------
    /** specifies if specific property values are searched,
        or just the existence of the specified properties.
     */
    void setValueSearch( [in] boolean bValueSearch );

    //-------------------------------------------------------------------------
    /** @returns
                    the attributes to search for.
     */
    sequence<com::sun::star::beans::PropertyValue> getSearchAttributes();

    //-------------------------------------------------------------------------
    /** sets the properties to search for.
     */
    void setSearchAttributes( [in] sequence<com::sun::star::beans::PropertyValue> aSearchAttribs )
            raises( com::sun::star::beans::UnknownPropertyException,
                    com::sun::star::lang::IllegalArgumentException );

    //-------------------------------------------------------------------------
    /** @returns
                    the attribute values which are used to replace the found occurrences.
     */
    sequence<com::sun::star::beans::PropertyValue> getReplaceAttributes();

    //-------------------------------------------------------------------------
    /** sets the properties to replace the found occurrences.
     */
    void setReplaceAttributes( [in] sequence<com::sun::star::beans::PropertyValue> aSearchAttribs )
            raises( com::sun::star::beans::UnknownPropertyException,
                    com::sun::star::lang::IllegalArgumentException );

};

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

}; }; }; };

#endif
