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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_rdf_URI_idl__
  21 #define __com_sun_star_rdf_URI_idl__
  22
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24 #include <com/sun/star/rdf/XURI.idl>
  25
  26
  27
  28 module com {   module sun {   module star {   module rdf {
  29
  30 /** represents an URI node that may occur in a RDF graph.
  31
  32     @since OOo 3.0
  33
  34     @see XRepository
  35  */
  36 service URI : XURI
  37 {
  38
  39     /** creates an URI RDF node.
  40
  41         @param Value
  42             the URI, represented as `string`.
  43
  44         @throws com::sun::star::lang::IllegalArgumentException
  45             if the argument does not represent a valid URI
  46      */
  47     create( [in] string Value )
  48         raises( com::sun::star::lang::IllegalArgumentException );
  49
  50     /** creates an URI RDF node from namespace prefix and local name.
  51
  52         @param Namespace
  53             the namespace prefix of the URI, represented as
  54             `string`.
  55
  56         @param LocalName
  57             the local name of the URI, represented as `string`.
  58
  59         @throws com::sun::star::lang::IllegalArgumentException
  60             if the arguments do not represent a valid URI
  61      */
  62     createNS( [in] string Namespace, [in] string LocalName )
  63         raises( com::sun::star::lang::IllegalArgumentException );
  64
  65     /** creates an URI RDF node for a well-known URI.
  66
  67         @param Id
  68             the URI, represented as a constant from URIs.
  69
  70         @throws com::sun::star::lang::IllegalArgumentException
  71             if the argument is not a valid constant from URIs
  72
  73         @see URIs
  74      */
  75     createKnown( [in] short Id )
  76         raises( com::sun::star::lang::IllegalArgumentException );
  77
  78 };
  79
  80
  81 }; }; }; };
  82
  83 #endif
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */