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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_XParameterizedContentProvider_idl__
  20 #define __com_sun_star_ucb_XParameterizedContentProvider_idl__
  21
  22 #include <com/sun/star/lang/IllegalArgumentException.idl>
  23 #include <com/sun/star/ucb/XContentProvider.idl>
  24 #include <com/sun/star/uno/XInterface.idl>
  25
  26
  27
  28 module com { module sun { module star { module ucb {
  29
  30 /** Register specially adjusted instances of content providers on URL
  31     templates and supplementary arguments.
  32
  33     @version 1.0
  34     @author Stephan Bergmann
  35 */
  36 published interface XParameterizedContentProvider: com::sun::star::uno::XInterface
  37 {
  38     /** Register a content provider on a URL template and supplementary
  39         arguments.
  40
  41         @param Template  A URL template.  If the input is malformed or too
  42         complex, an com::sun::star::lang::IllegalArgumentException may be raised.
  43
  44         @param Arguments  Any supplementary arguments required by this
  45         XContentProvider, represented as a single string.  If the
  46         input is malformed, an
  47         com::sun::star::lang::IllegalArgumentException
  48         may be raised.
  49
  50         @param ReplaceExisting  If true, and if the given Template conflicts
  51         with an already registered instance, the old registration is replaced
  52         by the new one.  If false, and if the given Template conflicts with an
  53         already registered instance, the new registration is not performed,
  54         and null is returned.
  55
  56         @return  Either this XContentProvider, or another,
  57         specially adjusted version of this XContentProvider (this
  58         flexibility allows for different implementation strategies), or null
  59         if the given Template conflicts with an already registered instance
  60         and ReplaceExisting is false.  Note that the returned
  61         XContentProvider must still be registered at the content
  62         provider manager!
  63     */
  64     com::sun::star::ucb::XContentProvider
  65     registerInstance([in] string Template,
  66                      [in] string Arguments,
  67                      [in] boolean ReplaceExisting)
  68         raises (com::sun::star::lang::IllegalArgumentException);
  69
  70     /** Deregisters a content provider.
  71
  72         @param Template  A URL template.  If the input is malformed or too
  73         complex, an IllegalArgumentException may be raised.
  74
  75         @param Arguments  Any supplementary arguments required by this
  76         XContentProvider, represented as a single string.  If the
  77         input is malformed, an
  78         com::sun::star::lang::IllegalArgumentException
  79         may be raised.
  80
  81         @return  Either this XContentProvider, or another,
  82         specially adjusted version of this XContentProvider (this
  83         flexibility allows for different implementation strategies), or null
  84         if no instance is registered for the given Template.  Note that the
  85         returned XContentProvider must still be deregistered at
  86         the content provider manager!
  87     */
  88     com::sun::star::ucb::XContentProvider
  89     deregisterInstance([in] string Template,
  90                        [in] string Arguments)
  91         raises (com::sun::star::lang::IllegalArgumentException);
  92 };
  93
  94
  95 }; }; }; };
  96
  97 #endif
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */