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

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