xref: /aoo42x/main/offapi/com/sun/star/rdf/URI.idl (revision 96af39f7)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_rdf_URI_idl__
25#define __com_sun_star_rdf_URI_idl__
26
27#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
28#include <com/sun/star/lang/IllegalArgumentException.idl>
29#endif
30
31#ifndef __com_sun_star_rdf_XURI_idl__
32#include <com/sun/star/rdf/XURI.idl>
33#endif
34
35
36//=============================================================================
37
38module com {   module sun {   module star {   module rdf {
39
40//=============================================================================
41/** represents an URI node that may occur in a RDF graph.
42
43    @since OpenOffice 3.0
44
45    @see XRepository
46 */
47service 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