1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_ucb_XParameterizedContentProvider_idl__ 24#define __com_sun_star_ucb_XParameterizedContentProvider_idl__ 25 26#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 27#include <com/sun/star/lang/IllegalArgumentException.idl> 28#endif 29 30#ifndef __com_sun_star_ucb_XContentProvider_idl__ 31#include <com/sun/star/ucb/XContentProvider.idl> 32#endif 33 34#ifndef __com_sun_star_uno_XInterface_idl__ 35#include <com/sun/star/uno/XInterface.idl> 36#endif 37 38 39//============================================================================= 40 41module com { module sun { module star { module ucb { 42 43//============================================================================= 44/** Register specially adjusted instances of content providers on URL 45 templates and supplementary arguments. 46 47 @version 1.0 48 @author Stephan Bergmann 49*/ 50published interface XParameterizedContentProvider: com::sun::star::uno::XInterface 51{ 52 //------------------------------------------------------------------------- 53 /** Register a content provider on a URL template and supplementary 54 arguments. 55 56 @param Template A URL template. If the input is malformed or too 57 complex, an <type scope="com::sun::star::lang">IllegalArgumentException</type> may be raised. 58 59 @param Arguments Any supplementary arguments required by this 60 <type>XContentProvider</type>, represented as a single string. If the 61 input is malformed, an 62 <type scope="com::sun::star::lang">IllegalArgumentException</type> 63 may be raised. 64 65 @param ReplaceExisting If true, and if the given Template conflicts 66 with an already registered instance, the old registration is replaced 67 by the new one. If false, and if the given Template conflicts with an 68 already registered instance, the new registration is not performed, 69 and null is returned. 70 71 @return Either this <type>XContentProvider</type>, or another, 72 specially adjusted version of this <type>XContentProvider</type> (this 73 flexibility allows for different implementation strategies), or null 74 if the given Template conflicts with an already registered instance 75 and ReplaceExisting is false. Note that the returned 76 <type>XContentProvider</type> must still be registered at the content 77 provider manager! 78 */ 79 com::sun::star::ucb::XContentProvider 80 registerInstance([in] string Template, 81 [in] string Arguments, 82 [in] boolean ReplaceExisting) 83 raises (com::sun::star::lang::IllegalArgumentException); 84 85 //------------------------------------------------------------------------- 86 /** Deregisters a content provider. 87 88 @param Template A URL template. If the input is malformed or too 89 complex, an IllegalArgumentException may be raised. 90 91 @param Arguments Any supplementary arguments required by this 92 <type>XContentProvider</type>, represented as a single string. If the 93 input is malformed, an 94 <type scope="com::sun::star::lang">IllegalArgumentException</type> 95 may be raised. 96 97 @return Either this <type>XContentProvider</type>, or another, 98 specially adjusted version of this <type>XContentProvider</type> (this 99 flexibility allows for different implementation strategies), or null 100 if no instance is registered for the given Template. Note that the 101 returned <type>XContentProvider</type> must still be deregistered at 102 the content provider manager! 103 */ 104 com::sun::star::ucb::XContentProvider 105 deregisterInstance([in] string Template, 106 [in] string Arguments) 107 raises (com::sun::star::lang::IllegalArgumentException); 108}; 109 110//============================================================================= 111 112}; }; }; }; 113 114#endif 115