offapi/com/sun/star/rdf/URI.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_rdf_URI_idl__
  29 #define __com_sun_star_rdf_URI_idl__
  30
  31 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  32 #include <com/sun/star/lang/IllegalArgumentException.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_rdf_XURI_idl__
  36 #include <com/sun/star/rdf/XURI.idl>
  37 #endif
  38
  39
  40 //=============================================================================
  41
  42 module com {   module sun {   module star {   module rdf {
  43
  44 //=============================================================================
  45 /** represents an URI node that may occur in a RDF graph.
  46
  47     @since OOo 3.0
  48
  49     @see XRepository
  50  */
  51 service URI : XURI
  52 {
  53
  54     //-------------------------------------------------------------------------
  55     /** creates an URI RDF node.
  56
  57         @param Value
  58             the URI, represented as <atom>string</atom>.
  59
  60         @throws com::sun::star::lang::IllegalArgumentException
  61             if the argument does not represent a valid URI
  62      */
  63     create( [in] string Value )
  64         raises( com::sun::star::lang::IllegalArgumentException );
  65
  66     //-------------------------------------------------------------------------
  67     /** creates an URI RDF node from namespace prefix and local name.
  68
  69         @param Namespace
  70             the namespace prefix of the URI, represented as
  71             <atom>string</atom>.
  72
  73         @param LocalName
  74             the local name of the URI, represented as <atom>string</atom>.
  75
  76         @throws com::sun::star::lang::IllegalArgumentException
  77             if the arguments do not represent a valid URI
  78      */
  79     createNS( [in] string Namespace, [in] string LocalName )
  80         raises( com::sun::star::lang::IllegalArgumentException );
  81
  82     //-------------------------------------------------------------------------
  83     /** creates an URI RDF node for a well-known URI.
  84
  85         @param Id
  86             the URI, represented as a constant from <type>URIs</type>.
  87
  88         @throws com::sun::star::lang::IllegalArgumentException
  89             if the argument is not a valid constant from <type>URIs</type>
  90
  91         @see URIs
  92      */
  93     createKnown( [in] short Id )
  94         raises( com::sun::star::lang::IllegalArgumentException );
  95
  96 };
  97
  98 //=============================================================================
  99
 100 }; }; }; };
 101
 102 #endif