offapi/com/sun/star/rdf/XMetadatable.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
  21
  22 module com {   module sun {   module star {   module rdf {
  23
  24 /** marks an object representing an ODF element that may have RDF meta data
  25     attached.
  26
  27     <p>
  28     To make using ODF elements as part of RDF statements more convenient,
  29     this interface inherits from XURI.
  30     The URI is constructed by concatenating the URI of the document, the
  31     stream name, a fragment separator, and the XML ID.
  32     </p>
  33
  34     <p>
  35     Note that using the XURI interface on an instance of
  36     XMetadatable may have the side effect of creating a metadata
  37     reference for the instance.
  38     </p>
  39
  40     @since OOo 3.2
  41
  42     @see XRepository
  43     @see XDocumentMetadataAccess
  44  */
  45 interface XMetadatable : XURI
  46 {
  47     /** a metadata reference, comprising the stream name and the XML ID.
  48
  49         <p>
  50         Note that this metadata reference must be unique for the ODF document.
  51         This implies that the XML ID part must be unique for every stream.
  52         A pair of two empty strings signifies "no metadata reference".
  53         For example: Pair("content.xml", "foo-element-1")
  54         </p>
  55
  56         @throws com::sun::star::lang::IllegalArgumentException
  57             if the given metadata reference is invalid, or not unique
  58      */
  59     [attribute] com::sun::star::beans::StringPair MetadataReference {
  60         set raises ( com::sun::star::lang::IllegalArgumentException );
  61     };
  62
  63     /** creates a metadata reference for this object, if necessary.
  64
  65         <p>
  66         If this object already has a metadata reference, do nothing;
  67         otherwise, create metadata reference with a fresh, unique XML ID
  68         and assign it to the MetadataReference attribute.
  69         </p>
  70      */
  71     void ensureMetadataReference();
  72
  73 };
  74
  75
  76 }; }; }; };
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */