/************************************************************************* * * $RCSfile: XParameterizedContentProvider.idl,v $ * * $Revision: 1.1 $ * * last change: $Author: mi $ $Date: 2000-11-06 09:22:32 $ * * 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 WARRANTY OF ANY KIND, EITHER EXPRESSED 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_ucb_XParameterizedContentProvider_idl__ #define __com_sun_star_ucb_XParameterizedContentProvider_idl__ #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ #include #endif #ifndef __com_sun_star_ucb_XContentProvider_idl__ #include #endif #ifndef __com_sun_star_uno_XInterface_idl__ #include #endif //============================================================================= module com { module sun { module star { module ucb { //============================================================================= /** Register specially adjusted instances of content providers on URL templates and supplementary arguments. @version 1.0 @author Stephan Bergmann */ [ uik(D8516270-5E24-11D4-9FAE0050-04526AAD), ident("XParameterizedContentProvider", 1.0) ] interface XParameterizedContentProvider: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** Register a content provider on a URL template and supplementary arguments. @param Template A URL template. If the input is malformed or too complex, an IllegalArgumentException may be raised. @param Arguments Any supplementary arguments required by this XContentProvider, represented as a single string. If the input is malformed, an IllegalArgumentException may be raised. @param ReplaceExisting If true, and if the given Template conflicts with an already registered instance, the old registration is replaced by the new one. If false, and if the given Template conflicts with an already registered instance, the new registration is not performed, and null is returned. @return Either this XContentProvider, or another, specially adjusted version of this XContentProvider (this flexibility allows for different implementation strategies), or null if the given Template conflicts with an already registered instance and ReplaceExisting is false. Note that the returned XContentProvider must still be registered at the content provider manager! */ com::sun::star::ucb::XContentProvider registerInstance([in] string Template, [in] string Arguments, [in] boolean ReplaceExisting) raises (com::sun::star::lang::IllegalArgumentException); //------------------------------------------------------------------------- /** Deregisters a content provider. @param Template A URL template. If the input is malformed or too complex, an IllegalArgumentException may be raised. @param Arguments Any supplementary arguments required by this XContentProvider, represented as a single string. If the input is malformed, an IllegalArgumentException may be raised. @return Either this XContentProvider, or another, specially adjusted version of this XContentProvider (this flexibility allows for different implementation strategies), or null if no instance is registered for the given Template. Note that the returned XContentProvider must still be deregistered at the content provider manager! */ com::sun::star::ucb::XContentProvider deregisterInstance([in] string Template, [in] string Arguments) raises (com::sun::star::lang::IllegalArgumentException); }; //============================================================================= }; }; }; }; #endif