udkapi/com/sun/star/lang/XMultiServiceFactory.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 lang {
  23
  24
  25 /** Allows creating instances specified by a string name.
  26
  27     @note
  28     Although this interface deals with the notion of "services", it is
  29     not restricted to services but is more general.
  30     This interface can be used for all kinds
  31     of factories for all kinds of instances, not only UNO services.
  32 */
  33 published interface XMultiServiceFactory: com::sun::star::uno::XInterface
  34 {
  35     /** Creates an instance classified by the specified name.
  36
  37         @param aServiceSpecifier
  38                classified name of instance
  39         @return
  40                 instance
  41     */
  42     com::sun::star::uno::XInterface createInstance( [in] string aServiceSpecifier )
  43         raises( com::sun::star::uno::Exception );
  44
  45     /** Creates an instance classified by the specified name and passes the arguments
  46         to that instance.
  47
  48         @param ServiceSpecifier
  49                classified name of instance
  50         @param Arguments
  51                arguments passed to the instance
  52         @return
  53                 instance
  54     */
  55     com::sun::star::uno::XInterface createInstanceWithArguments(
  56         [in] string ServiceSpecifier,
  57         [in] sequence<any> Arguments )
  58         raises( com::sun::star::uno::Exception );
  59
  60     /** Provides the available names of the factory to be used to create instances.
  61
  62         @returns
  63                  sequence of all names
  64     */
  65     sequence<string> getAvailableServiceNames();
  66 };
  67
  68
  69 }; }; }; };
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */