/*************************************************************************
 *
 *  $RCSfile: XBindingStore.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: Laszlo Kovacs: mi $ $Date: 2002/08/16 10:10:35 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 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
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRUNTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc..
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef __com_sun_star_scripting_storage_XBindingStore_idl__
#define __com_sun_star_scripting_storage_XBindingStore_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_scripting_storage_XBinding_idl__
#include <drafts/com/sun/star/scripting/storage/XBinding.idl>
#endif

#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

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

module drafts { module com { module sun { module star { module scripting { module storage {


//========================================================================
/**
    XBindingStore
        provides access to the binding storage of a document or the 
        application
*/
interface XBindingStore : ::com::sun::star::uno::XInterface
{
	//---------------------------------------------------------------
	/**
	    store one binding
	
	    @params binding
		the binding

	    @throws com::sun::star::io::IOException
		if the underlying storage can not be accessed
	*/
        void storeBinding([in] XBinding binding)
                raises( ::com::sun::star::io::IOException );

	//---------------------------------------------------------------
        /**
            store a sequence of  bindings

            @params bindings
                the set of bindings

            @throws com::sun::star::io::IOException
                if the underlying storage can not be accessed
        */
        void storeBindings([in] sequence <XBinding> bindings)
                raises( ::com::sun::star::io::IOException );

	//---------------------------------------------------------------
        /**
            remove one binding

            @params binding
                the binding

            @throws com::sun::star::io::IOException
                if the underlying storage can not be accessed
        */
        void removeBinding([in] XBinding binding)
                raises( ::com::sun::star::io::IOException );
	
	//---------------------------------------------------------------
        /**
            remove all bindings

            @throws com::sun::star::io::IOException
                if the underlying storage can not be accessed
        */
        void removeAllBindings()
                raises( ::com::sun::star::io::IOException );

        //---------------------------------------------------------------
        /**
            retrieve all binding

	    @returns a sequence of XBinding containing all the bindings

            @throws com::sun::star::io::IOException
                if the underlying storage can not be accessed
        */
        sequence <XBinding> getAllBindings()
                raises( ::com::sun::star::io::IOException );

	//---------------------------------------------------------------
        /**
            retrieve all scripts (by name) bound to the specified event

            @params event 
                the event identified by name

	    @returns a sequence of script names bound to the specified
		event

            @throws com::sun::star::io::IOException
                if the underlying storage can not be accessed
        */
        sequence <string> getScriptsBoundToEvent([in] string event)
                raises( ::com::sun::star::io::IOException );

	//---------------------------------------------------------------
	/**
	    retrieve all events (by name) that the specified script is bound to

            @params scriptName 
                the script identified by name

            @returns a sequence of event names that this script is bound to

            @throws com::sun::star::io::IOException
                if the underlying storage can not be accessed
        */
        sequence <string> getEventsScriptIsBoundTo([in] string scriptName)
                raises( ::com::sun::star::io::IOException );

	//---------------------------------------------------------------
        /**
            set binding properties 

            @params binding 
                the binding

            @params properties
		the properties

            @throws com::sun::star::io::IOException
                if the underlying storage can not be accessed
        */
        void setBindingProperties([in] XBinding binding, [in] com::sun::star::beans::XPropertySet properties)
                raises( ::com::sun::star::io::IOException );

	//---------------------------------------------------------------
        /**
            set binding proerties

            @params binding
                the binding

            @returns the properties

            @throws com::sun::star::io::IOException
                if the underlying storage can not be accessed
        */
        com::sun::star::beans::XPropertySet getBindingProperties([in] XBinding binding)
                raises( ::com::sun::star::io::IOException );
};
}; }; }; }; }; };
#endif