1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_rdf_XMetadatable_idl__
#define __com_sun_star_rdf_XMetadatable_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/beans/StringPair.idl>
#include <com/sun/star/rdf/XURI.idl>
module com { module sun { module star { module rdf {
/** marks an object representing an ODF element that may have RDF meta data
attached.
<p>
To make using ODF elements as part of RDF statements more convenient,
this interface inherits from XURI.
The URI is constructed by concatenating the URI of the document, the
stream name, a fragment separator, and the XML ID.
</p>
<p>
Note that using the XURI interface on an instance of
XMetadatable may have the side effect of creating a metadata
reference for the instance.
</p>
@since OOo 3.2
@see XRepository
@see XDocumentMetadataAccess
*/
interface XMetadatable : XURI
{
/** a metadata reference, comprising the stream name and the XML ID.
<p>
Note that this metadata reference must be unique for the ODF document.
This implies that the XML ID part must be unique for every stream.
A pair of two empty strings signifies "no metadata reference".
For example: Pair("content.xml", "foo-element-1")
</p>
@throws com::sun::star::lang::IllegalArgumentException
if the given metadata reference is invalid, or not unique
*/
[attribute] com::sun::star::beans::StringPair MetadataReference {
set raises ( com::sun::star::lang::IllegalArgumentException );
};
/** creates a metadata reference for this object, if necessary.
<p>
If this object already has a metadata reference, do nothing;
otherwise, create metadata reference with a fresh, unique XML ID
and assign it to the MetadataReference attribute.
</p>
*/
void ensureMetadataReference();
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
