LibreOffice LibreOffice 26.2 SDK API Reference

XDocumentMetadataAccess.idl
Go to the documentation of this file.
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
22module com { module sun { module star { module rdf {
23
43 interface XDocumentMetadataAccess
44{
45 interface XURI;
46 interface XRepositorySupplier;
47
58 XMetadatable getElementByMetadataReference(
59 [in] com::sun::star::beans::StringPair MetadataReference);
60
72 XMetadatable getElementByURI([in] XURI URI)
73 raises( com::sun::star::lang::IllegalArgumentException );
74
87 sequence<XURI> getMetadataGraphsWithType([in] XURI Type)
88 raises( com::sun::star::lang::IllegalArgumentException );
89
120 XURI addMetadataFile([in] string FileName,
121 [in] sequence<XURI> Types )
122 raises( com::sun::star::lang::IllegalArgumentException,
123 com::sun::star::container::ElementExistException );
124
179 XURI importMetadataFile( [in] /*FileFormat*/ short Format,
180 [in] com::sun::star::io::XInputStream InStream,
181 [in] string FileName, [in] XURI BaseURI,
182 [in] sequence<XURI> Types )
183 raises( com::sun::star::lang::IllegalArgumentException,
184 com::sun::star::datatransfer::UnsupportedFlavorException,
185 com::sun::star::container::ElementExistException,
186 ParseException,
187 com::sun::star::io::IOException );
188
209 void removeMetadataFile([in] XURI GraphName)
210 raises( com::sun::star::lang::IllegalArgumentException,
211 com::sun::star::container::NoSuchElementException );
212
236 void addContentOrStylesFile([in] string FileName)
237 raises( com::sun::star::lang::IllegalArgumentException,
238 com::sun::star::container::ElementExistException );
239
256 void removeContentOrStylesFile([in] string FileName)
257 raises( com::sun::star::lang::IllegalArgumentException,
258 com::sun::star::container::NoSuchElementException );
259
297 void loadMetadataFromStorage(
298 [in] com::sun::star::embed::XStorage Storage,
299 [in] XURI BaseURI,
300 [in] com::sun::star::task::XInteractionHandler InteractionHandler )
301 raises( com::sun::star::lang::IllegalArgumentException,
302 com::sun::star::lang::WrappedTargetException );
303
325 void storeMetadataToStorage(
326 [in] com::sun::star::embed::XStorage Storage )
327 raises( com::sun::star::lang::IllegalArgumentException,
328 com::sun::star::lang::WrappedTargetException );
329
347 void loadMetadataFromMedium(
348 [in] sequence < com::sun::star::beans::PropertyValue > Medium )
349 raises( com::sun::star::lang::IllegalArgumentException,
350 com::sun::star::lang::WrappedTargetException );
351
366 void storeMetadataToMedium(
367 [in] sequence < com::sun::star::beans::PropertyValue > Medium )
368 raises( com::sun::star::lang::IllegalArgumentException,
369 com::sun::star::lang::WrappedTargetException );
370
371};
372
373
374}; }; }; };
375
376/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::ElementExistException
is thrown by container methods, if an element is added which is already a child of the container.
Definition: ElementExistException.idl:35
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:31
com::sun::star::datatransfer::UnsupportedFlavorException
Exception will be thrown if there is a request for data in a DataFlavor that is not supported by a da...
Definition: UnsupportedFlavorException.idl:30
com::sun::star::io::IOException
is thrown when an input or output error has occurred.
Definition: IOException.idl:27
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::lang::WrappedTargetException
This is a checked exception that wraps an exception thrown by the original target.
Definition: WrappedTargetException.idl:34
com::sun::star::rdf::ParseException
represents an error condition that is signaled on parsing an RDF file.
Definition: ParseException.idl:30
com::sun::star::embed::XStorage
This interface represents main storage functionality.
Definition: XStorage.idl:27
com::sun::star::io::XInputStream
This is the basic interface to read data from a stream.
Definition: XInputStream.idl:30
com::sun::star::rdf::XDocumentMetadataAccess
document metadata functionality related to the "manifest.rdf".
Definition: XDocumentMetadataAccess.idl:44
com::sun::star::rdf::XDocumentMetadataAccess::loadMetadataFromStorage
void loadMetadataFromStorage([in] com::sun::star::embed::XStorage Storage, [in] XURI BaseURI, [in] com::sun::star::task::XInteractionHandler InteractionHandler)
initialize document metadata from a storage.
com::sun::star::rdf::XDocumentMetadataAccess::removeMetadataFile
void removeMetadataFile([in] XURI GraphName)
remove a metadata file from the manifest and the repository.
com::sun::star::rdf::XDocumentMetadataAccess::addMetadataFile
XURI addMetadataFile([in] string FileName, [in] sequence< XURI > Types)
add a metadata file to the manifest.
com::sun::star::rdf::XDocumentMetadataAccess::getElementByURI
XMetadatable getElementByURI([in] XURI URI)
get the ODF element that corresponds to a URI.
com::sun::star::rdf::XDocumentMetadataAccess::loadMetadataFromMedium
void loadMetadataFromMedium([in] sequence< com::sun::star::beans::PropertyValue > Medium)
loads document metadata from a medium.
com::sun::star::rdf::XDocumentMetadataAccess::getElementByMetadataReference
XMetadatable getElementByMetadataReference([in] com::sun::star::beans::StringPair MetadataReference)
get the unique ODF element with the given metadata reference.
com::sun::star::rdf::XDocumentMetadataAccess::storeMetadataToMedium
void storeMetadataToMedium([in] sequence< com::sun::star::beans::PropertyValue > Medium)
stores document metadata to a medium.
com::sun::star::rdf::XDocumentMetadataAccess::importMetadataFile
XURI importMetadataFile([in] short Format, [in] com::sun::star::io::XInputStream InStream, [in] string FileName, [in] XURI BaseURI, [in] sequence< XURI > Types)
import a metadata file into the document repository, and add it to the manifest.
com::sun::star::rdf::XDocumentMetadataAccess::getMetadataGraphsWithType
sequence< XURI > getMetadataGraphsWithType([in] XURI Type)
get the names of all metadata files with a given type.
com::sun::star::rdf::XDocumentMetadataAccess::removeContentOrStylesFile
void removeContentOrStylesFile([in] string FileName)
remove a content or styles file from the manifest.
com::sun::star::rdf::XDocumentMetadataAccess::storeMetadataToStorage
void storeMetadataToStorage([in] com::sun::star::embed::XStorage Storage)
store document metadata to a storage.
com::sun::star::rdf::XDocumentMetadataAccess::addContentOrStylesFile
void addContentOrStylesFile([in] string FileName)
add a content or styles file to the manifest.
com::sun::star::rdf::XMetadatable
marks an object representing an ODF element that may have RDF meta data attached.
Definition: XMetadatable.idl:46
com::sun::star::rdf::XRepositorySupplier
provides access to an RDF Repository.
Definition: XRepositorySupplier.idl:31
com::sun::star::rdf::XURI
represents a URI node that may occur in a RDF graph.
Definition: XURI.idl:49
com::sun::star::task::XInteractionHandler
An interaction request handler.
Definition: XInteractionHandler.idl:27
com
Definition: Ambiguous.idl:20
com::sun::star::rdf::URI
represents a URI node that may occur in a RDF graph.
Definition: URI.idl:31
com::sun::star::beans::StringPair
specifies a pair of two strings.
Definition: StringPair.idl:27