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