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
  20
  21
  22 module com { module sun { module star { module ucb {
  23
  24 /** Register specially adjusted instances of content providers on URL
  25     templates and supplementary arguments.
  26
  27     @version 1.0
  28 */
  29 published interface XParameterizedContentProvider: com::sun::star::uno::XInterface
  30 {
  31     /** Register a content provider on a URL template and supplementary
  32         arguments.
  33
  34         @param Template  A URL template.  If the input is malformed or too
  35         complex, a com::sun::star::lang::IllegalArgumentException may be raised.
  36
  37         @param Arguments  Any supplementary arguments required by this
  38         XContentProvider, represented as a single string.  If the
  39         input is malformed, an
  40         com::sun::star::lang::IllegalArgumentException
  41         may be raised.
  42
  43         @param ReplaceExisting  If true, and if the given Template conflicts
  44         with an already registered instance, the old registration is replaced
  45         by the new one.  If false, and if the given Template conflicts with an
  46         already registered instance, the new registration is not performed,
  47         and null is returned.
  48
  49         @return  Either this XContentProvider, or another,
  50         specially adjusted version of this XContentProvider (this
  51         flexibility allows for different implementation strategies), or null
  52         if the given Template conflicts with an already registered instance
  53         and ReplaceExisting is false.  Note that the returned
  54         XContentProvider must still be registered at the content
  55         provider manager!
  56     */
  57     com::sun::star::ucb::XContentProvider
  58     registerInstance([in] string Template,
  59                      [in] string Arguments,
  60                      [in] boolean ReplaceExisting)
  61         raises (com::sun::star::lang::IllegalArgumentException);
  62
  63     /** Deregisters a content provider.
  64
  65         @param Template  A URL template.  If the input is malformed or too
  66         complex, an IllegalArgumentException may be raised.
  67
  68         @param Arguments  Any supplementary arguments required by this
  69         XContentProvider, represented as a single string.  If the
  70         input is malformed, an
  71         com::sun::star::lang::IllegalArgumentException
  72         may be raised.
  73
  74         @return  Either this XContentProvider, or another,
  75         specially adjusted version of this XContentProvider (this
  76         flexibility allows for different implementation strategies), or null
  77         if no instance is registered for the given Template.  Note that the
  78         returned XContentProvider must still be deregistered at
  79         the content provider manager!
  80     */
  81     com::sun::star::ucb::XContentProvider
  82     deregisterInstance([in] string Template,
  83                        [in] string Arguments)
  84         raises (com::sun::star::lang::IllegalArgumentException);
  85 };
  86
  87
  88 }; }; }; };
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */