offapi/com/sun/star/rdf/URI.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: URI.idl,v $
  10  * $Revision: 1.2 $
  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_rdf_URI_idl__
  32 #define __com_sun_star_rdf_URI_idl__
  33
  34 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  35 #include <com/sun/star/lang/IllegalArgumentException.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_rdf_XURI_idl__
  39 #include <com/sun/star/rdf/XURI.idl>
  40 #endif
  41
  42
  43 //=============================================================================
  44
  45 module com {   module sun {   module star {   module rdf {
  46
  47 //=============================================================================
  48 /** represents an URI node that may occur in a RDF graph.
  49
  50     @since OOo 3.0
  51
  52     @see XRepository
  53  */
  54 service URI : XURI
  55 {
  56
  57     //-------------------------------------------------------------------------
  58     /** creates an URI RDF node.
  59
  60         @param Value
  61             the URI, represented as <atom>string</atom>.
  62
  63         @throws com::sun::star::lang::IllegalArgumentException
  64             if the argument does not represent a valid URI
  65      */
  66     create( [in] string Value )
  67         raises( com::sun::star::lang::IllegalArgumentException );
  68
  69     //-------------------------------------------------------------------------
  70     /** creates an URI RDF node from namespace prefix and local name.
  71
  72         @param Namespace
  73             the namespace prefix of the URI, represented as
  74             <atom>string</atom>.
  75
  76         @param LocalName
  77             the local name of the URI, represented as <atom>string</atom>.
  78
  79         @throws com::sun::star::lang::IllegalArgumentException
  80             if the arguments do not represent a valid URI
  81      */
  82     createNS( [in] string Namespace, [in] string LocalName )
  83         raises( com::sun::star::lang::IllegalArgumentException );
  84
  85     //-------------------------------------------------------------------------
  86     /** creates an URI RDF node for a well-known URI.
  87
  88         @param Id
  89             the URI, represented as a constant from <type>URIs</type>.
  90
  91         @throws com::sun::star::lang::IllegalArgumentException
  92             if the argument is not a valid constant from <type>URIs</type>
  93
  94         @see URIs
  95      */
  96     createKnown( [in] short Id )
  97         raises( com::sun::star::lang::IllegalArgumentException );
  98
  99 };
 100
 101 //=============================================================================
 102
 103 }; }; }; };
 104
 105 #endif