offapi/com/sun/star/ucb/XParameterizedContentProvider.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_ucb_XParameterizedContentProvider_idl__
  28 #define __com_sun_star_ucb_XParameterizedContentProvider_idl__
  29
  30 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  31 #include <com/sun/star/lang/IllegalArgumentException.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_ucb_XContentProvider_idl__
  35 #include <com/sun/star/ucb/XContentProvider.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_uno_XInterface_idl__
  39 #include <com/sun/star/uno/XInterface.idl>
  40 #endif
  41
  42
  43 //=============================================================================
  44
  45 module com { module sun { module star { module ucb {
  46
  47 //=============================================================================
  48 /** Register specially adjusted instances of content providers on URL
  49     templates and supplementary arguments.
  50
  51     @version 1.0
  52     @author Stephan Bergmann
  53 */
  54 published interface XParameterizedContentProvider: com::sun::star::uno::XInterface
  55 {
  56     //-------------------------------------------------------------------------
  57     /** Register a content provider on a URL template and supplementary
  58         arguments.
  59
  60         @param Template  A URL template.  If the input is malformed or too
  61         complex, an <type scope="com::sun::star::lang">IllegalArgumentException</type> may be raised.
  62
  63         @param Arguments  Any supplementary arguments required by this
  64         <type>XContentProvider</type>, represented as a single string.  If the
  65         input is malformed, an
  66         <type scope="com::sun::star::lang">IllegalArgumentException</type>
  67         may be raised.
  68
  69         @param ReplaceExisting  If true, and if the given Template conflicts
  70         with an already registered instance, the old registration is replaced
  71         by the new one.  If false, and if the given Template conflicts with an
  72         already registered instance, the new registration is not performed,
  73         and null is returned.
  74
  75         @return  Either this <type>XContentProvider</type>, or another,
  76         specially adjusted version of this <type>XContentProvider</type> (this
  77         flexibility allows for different implementation strategies), or null
  78         if the given Template conflicts with an already registered instance
  79         and ReplaceExisting is false.  Note that the returned
  80         <type>XContentProvider</type> must still be registered at the content
  81         provider manager!
  82     */
  83     com::sun::star::ucb::XContentProvider
  84     registerInstance([in] string Template,
  85                      [in] string Arguments,
  86                      [in] boolean ReplaceExisting)
  87         raises (com::sun::star::lang::IllegalArgumentException);
  88
  89     //-------------------------------------------------------------------------
  90     /** Deregisters a content provider.
  91
  92         @param Template  A URL template.  If the input is malformed or too
  93         complex, an IllegalArgumentException may be raised.
  94
  95         @param Arguments  Any supplementary arguments required by this
  96         <type>XContentProvider</type>, represented as a single string.  If the
  97         input is malformed, an
  98         <type scope="com::sun::star::lang">IllegalArgumentException</type>
  99         may be raised.
 100
 101         @return  Either this <type>XContentProvider</type>, or another,
 102         specially adjusted version of this <type>XContentProvider</type> (this
 103         flexibility allows for different implementation strategies), or null
 104         if no instance is registered for the given Template.  Note that the
 105         returned <type>XContentProvider</type> must still be deregistered at
 106         the content provider manager!
 107     */
 108     com::sun::star::ucb::XContentProvider
 109     deregisterInstance([in] string Template,
 110                        [in] string Arguments)
 111         raises (com::sun::star::lang::IllegalArgumentException);
 112 };
 113
 114 //=============================================================================
 115
 116 }; }; }; };
 117
 118 #endif