/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XPropertyReplace.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 09:12:44 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#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
