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

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