udkapi/com/sun/star/uri/XVndSunStarScriptUrl.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: XVndSunStarScriptUrl.idl,v $
  10  * $Revision: 1.9 $
  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_XVndSunStarScriptUrl_idl__
  32 #define __com_sun_star_uri_XVndSunStarScriptUrl_idl__
  33
  34 #include <com/sun/star/lang/IllegalArgumentException.idl>
  35 #include <com/sun/star/uno/XInterface.idl>
  36
  37 module com { module sun { module star { module uri {
  38
  39 /**
  40    represents absolute &ldquo;vnd.sun.star.script&rdquo; URLs.
  41
  42    <p>These URLs are of the form<br/>
  43    &emsp;<var>vnd-sun-star-script-url</var> =
  44    <code>"VND.SUN.STAR.SCRIPT:"</code> <var>name</var> [<code>"?"</code>
  45    <var>parameter</var> *(<code>"&"</code> <var>parameter</var>)]<br/>
  46    &emsp;<var>name</var> = 1*<var>schar</var><br/>
  47    &emsp;<var>parameter</var> = <var>key</var> <code>"="</code>
  48    <var>value</var><br/>
  49    &emsp;<var>key</var> = 1*<var>schar</var><br/>
  50    &emsp;<var>value</var> = *<var>schar</var><br/>
  51    &emsp;<var>schar</var> = <var>unreserved</var> / <var>escaped</var> /
  52    <code>"$"</code> / <code>"+"</code> / <code>","</code> / <code>":"</code> /
  53    <code>";"</code> / <code>"@"</code> / <code>"["</code> /
  54    <code>"]"</code><br/>
  55    See <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC&nbsp;2396</a>,
  56    <a href="http://www.ietf.org/rfc/rfc2732.txt">RFC&nbsp;2732</a>, and
  57    <a href="http://www.ietf.org/rfc/rfc2234.txt">RFC&nbsp;2234</a> for
  58    details.</p>
  59
  60    <p>The names, keys, and values are arbitrary Unicode strings (non-empty
  61    Unicode strings in the case of names and keys), encoded as UTF-8 byte
  62    sequences.  It is an error if any of them does not represent a valid UTF-8
  63    byte sequence.  Keys are compared for equality character-by-character,
  64    without considering case folding or normalization.  There may be multiple
  65    parameters with equal keys.</p>
  66
  67    @since OOo 2.0.0
  68  */
  69 published interface XVndSunStarScriptUrl: com::sun::star::uno::XInterface {
  70     /**
  71        returns the name part of this URL.
  72
  73        @returns
  74        the non-escaped value of the name part.
  75      */
  76     string getName();
  77
  78     /**
  79         sets the name part of this URL.
  80
  81         @param name
  82         specifies the non-escaped new name part of the URL.
  83
  84         @throws ::com::sun::star::lang::IllegalArgumentException
  85         if <arg>name</arg> is empty
  86
  87         @since OOo 3.0
  88     */
  89     void   setName([in] string name)
  90         raises ( ::com::sun::star::lang::IllegalArgumentException );
  91
  92     /**
  93        returns whether this URL has a parameter with a given key.
  94
  95        @param key
  96        a non-escaped key.
  97
  98        @returns
  99        <TRUE/> if this URL has at least one parameter with the given key.  In
 100        particular, if <code>key</code> is an empty <atom>string</atom>, <FALSE/>
 101        is returned.
 102      */
 103     boolean hasParameter([in] string key);
 104
 105     /**
 106        returns the value of a parameter with a given key.
 107
 108        @param key
 109        a non-escaped key.
 110
 111        @returns
 112        the non-escaped value of the first parameter with the given key.  If
 113        there is no parameter with the given key, or if <code>key</code> is an
 114        empty <atom>string</atom>, an empty <atom>string</atom> is returned.
 115      */
 116     string getParameter([in] string key);
 117
 118     /**
 119         sets the value of a parameter with a given key.
 120
 121         @param key
 122         a non-escaped key
 123
 124         @param value
 125         the non-escaped value to be set for the parameter. If there already is a
 126         parameter with this key, the value of its first appearance will be replaced.
 127         Otherwise, a parameter with the given key/value will be appended.
 128
 129         @throws ::com::sun::star::lang::IllegalArgumentException
 130         if <arg>key</arg> is empty
 131
 132         @since OOo 3.0
 133     */
 134     void setParameter( [in] string key, [in] string value )
 135         raises ( ::com::sun::star::lang::IllegalArgumentException );
 136 };
 137
 138 }; }; }; };
 139
 140 #endif