udkapi/com/sun/star/uri/XVndSunStarPkgUrlReferenceFactory.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XVndSunStarPkgUrlReferenceFactory.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_uri_XVndSunStarPkgUrlReferenceFactory_idl__
  32 #define __com_sun_star_uri_XVndSunStarPkgUrlReferenceFactory_idl__
  33
  34 #include <com/sun/star/uno/XInterface.idl>
  35
  36 module com { module sun { module star { module uri {
  37
  38 published interface XUriReference;
  39
  40 /**
  41    creates &ldquo;vnd.sun.star.pkg&rdquo; URL references.
  42
  43    @since OOo 2.0.0
  44  */
  45 published interface XVndSunStarPkgUrlReferenceFactory {
  46     /**
  47        creates a new &ldquo;vnd.sun.star.pkg&rdquo; URL reference.
  48
  49        <p>The returned URL reference has the given authority, an empty path, and
  50        no fragment.</p>
  51
  52        @param authority the authority of the created URL reference; must not be
  53        <NULL/>, and should be an absolute URI reference with no fragment
  54
  55        @return a new &ldquo;vnd.sun.star.pkg&rdquo; URL reference, or <NULL/> if
  56        the given authority is either not an absolute URI reference or has a
  57        fragment
  58      */
  59     XUriReference createVndSunStarPkgUrlReference([in] XUriReference authority);
  60 };
  61
  62 }; }; }; };
  63
  64 #endif