1d1766043SAndrew Rist/**************************************************************
2d1766043SAndrew Rist *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10d1766043SAndrew Rist *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12d1766043SAndrew Rist *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19d1766043SAndrew Rist *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_rdf_XMetadatable_idl__
25cdf0e10cSrcweir#define __com_sun_star_rdf_XMetadatable_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
28cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir
31cdf0e10cSrcweir#ifndef __com_sun_star_beans_StringPair_idl__
32cdf0e10cSrcweir#include <com/sun/star/beans/StringPair.idl>
33cdf0e10cSrcweir#endif
34cdf0e10cSrcweir
35cdf0e10cSrcweir#ifndef __com_sun_star_rdf_XURI_idl__
36cdf0e10cSrcweir#include <com/sun/star/rdf/XURI.idl>
37cdf0e10cSrcweir#endif
38cdf0e10cSrcweir
39cdf0e10cSrcweir
40cdf0e10cSrcweir//=============================================================================
41cdf0e10cSrcweir
42cdf0e10cSrcweirmodule com {   module sun {   module star {   module rdf {
43cdf0e10cSrcweir
44cdf0e10cSrcweir//=============================================================================
45cdf0e10cSrcweir/** marks an object representing an ODF element that may have RDF meta data
46cdf0e10cSrcweir    attached.
47cdf0e10cSrcweir
48cdf0e10cSrcweir    <p>
49cdf0e10cSrcweir    To make using ODF elements as part of RDF statements more convenient,
50cdf0e10cSrcweir    this interface inherits from <type>XURI</type>.
51cdf0e10cSrcweir    The URI is constructed by concatenating the URI of the document, the
52cdf0e10cSrcweir    stream name, a fragment separator, and the XML ID.
53cdf0e10cSrcweir    </p>
54cdf0e10cSrcweir
55cdf0e10cSrcweir    <p>
56cdf0e10cSrcweir    Note that using the <type>XURI</type> interface on an instance of
57cdf0e10cSrcweir    <type>XMetadatable</type> may have the side effect of creating a metadata
58cdf0e10cSrcweir    reference for the instance.
59cdf0e10cSrcweir    </p>
60cdf0e10cSrcweir
61*96af39f7SJürgen Schmidt    @since OpenOffice 3.2
62cdf0e10cSrcweir
63cdf0e10cSrcweir    @see XRepository
64cdf0e10cSrcweir    @see XDocumentMetadataAccess
65cdf0e10cSrcweir */
66cdf0e10cSrcweirpublished interface XMetadatable : XURI
67cdf0e10cSrcweir{
68cdf0e10cSrcweir    //-------------------------------------------------------------------------
69cdf0e10cSrcweir    /** a metadata reference, comprising the stream name and the XML ID.
70cdf0e10cSrcweir
71cdf0e10cSrcweir        <p>
72cdf0e10cSrcweir        Note that this metadata reference must be unique for the ODF document.
73cdf0e10cSrcweir        This implies that the XML ID part must be unique for every stream.
74cdf0e10cSrcweir        A pair of two empty strings signifies "no metadata reference".
75cdf0e10cSrcweir        For example: Pair("content.xml", "foo-element-1")
76cdf0e10cSrcweir        </p>
77cdf0e10cSrcweir
78cdf0e10cSrcweir        @throws com::sun::star::lang::IllegalArgumentException
79cdf0e10cSrcweir            if the given metadata reference is invalid, or not unique
80cdf0e10cSrcweir     */
81cdf0e10cSrcweir    [attribute] com::sun::star::beans::StringPair MetadataReference {
82cdf0e10cSrcweir        set raises ( com::sun::star::lang::IllegalArgumentException );
83cdf0e10cSrcweir    };
84cdf0e10cSrcweir
85cdf0e10cSrcweir    //-------------------------------------------------------------------------
86cdf0e10cSrcweir    /** creates a metadata reference for this object, if necessary.
87cdf0e10cSrcweir
88cdf0e10cSrcweir        <p>
89cdf0e10cSrcweir        If this object already has a metadata reference, do nothing;
90cdf0e10cSrcweir        otherwise, create metadata reference with a fresh, unique XML ID
91cdf0e10cSrcweir        and assign it to the MetadataReference attribute.
92cdf0e10cSrcweir        </p>
93cdf0e10cSrcweir     */
94cdf0e10cSrcweir    void ensureMetadataReference();
95cdf0e10cSrcweir
96cdf0e10cSrcweir};
97cdf0e10cSrcweir
98cdf0e10cSrcweir//=============================================================================
99cdf0e10cSrcweir
100cdf0e10cSrcweir}; }; }; };
101cdf0e10cSrcweir
102cdf0e10cSrcweir#endif
103