LibreOffice LibreOffice 25.2 SDK API Reference

XOptimizedStorage.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 module com { module sun { module star { module embed {
22
28published interface XOptimizedStorage
29{
33 void insertRawNonEncrStreamElementDirect(
34 [in] string sStreamName,
35 [in] ::com::sun::star::io::XInputStream xInStream )
36 raises( ::com::sun::star::embed::InvalidStorageException,
37 ::com::sun::star::lang::IllegalArgumentException,
38 ::com::sun::star::packages::NoRawFormatException,
39 ::com::sun::star::container::ElementExistException,
40 ::com::sun::star::io::IOException,
41 ::com::sun::star::embed::StorageWrappedTargetException );
42
46 void insertStreamElementDirect(
47 [in] string sStreamName,
48 [in] ::com::sun::star::io::XInputStream xInStream,
49 [in] sequence < ::com::sun::star::beans::PropertyValue > aProperties )
50 raises( ::com::sun::star::embed::InvalidStorageException,
51 ::com::sun::star::lang::IllegalArgumentException,
52 ::com::sun::star::container::ElementExistException,
53 ::com::sun::star::io::IOException,
54 ::com::sun::star::embed::StorageWrappedTargetException );
55
58 void copyElementDirectlyTo(
59 [in] string sSourceName,
60 [in] ::com::sun::star::embed::XOptimizedStorage xTargetStorage,
61 [in] string sTargetName )
62 raises( ::com::sun::star::embed::InvalidStorageException,
63 ::com::sun::star::lang::IllegalArgumentException,
64 ::com::sun::star::container::NoSuchElementException,
65 ::com::sun::star::container::ElementExistException,
66 ::com::sun::star::io::IOException,
67 ::com::sun::star::embed::StorageWrappedTargetException );
68
74 void writeAndAttachToStream(
75 [in] ::com::sun::star::io::XStream xStream )
76 raises( ::com::sun::star::embed::InvalidStorageException,
77 ::com::sun::star::lang::IllegalArgumentException,
78 ::com::sun::star::io::IOException,
79 ::com::sun::star::embed::StorageWrappedTargetException );
80
87 void attachToURL( [in] string sURL,
88 [in] boolean bReadOnly )
89 raises( ::com::sun::star::embed::InvalidStorageException,
90 ::com::sun::star::lang::IllegalArgumentException,
91 ::com::sun::star::io::IOException,
92 ::com::sun::star::embed::StorageWrappedTargetException );
93
98 any getElementPropertyValue( [in] string sElementName,
99 [in] string sPropertyName )
100 raises( ::com::sun::star::embed::InvalidStorageException,
101 ::com::sun::star::lang::IllegalArgumentException,
102 ::com::sun::star::container::NoSuchElementException,
103 ::com::sun::star::io::IOException,
104 ::com::sun::star::beans::UnknownPropertyException,
105 ::com::sun::star::beans::PropertyVetoException,
106 ::com::sun::star::embed::StorageWrappedTargetException );
107
132 void copyStreamElementData( [in] string sStreamName,
133 [in] ::com::sun::star::io::XStream xTargetStream )
134 raises( ::com::sun::star::embed::InvalidStorageException,
135 ::com::sun::star::lang::IllegalArgumentException,
136 ::com::sun::star::packages::WrongPasswordException,
137 ::com::sun::star::io::IOException,
138 ::com::sun::star::embed::StorageWrappedTargetException );
139
140};
141
142
143}; }; }; };
144
145/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::beans::PropertyVetoException
This exception is thrown when a proposed change to a property represents an unacceptable value.
Definition: PropertyVetoException.idl:31
com::sun::star::beans::UnknownPropertyException
This exception is thrown to indicate that the property name is unknown to the implementation.
Definition: UnknownPropertyException.idl:31
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::embed::InvalidStorageException
This exception can be thrown in case a storage is invalid.
Definition: InvalidStorageException.idl:32
com::sun::star::embed::StorageWrappedTargetException
This exception can wrap an exception thrown during XStorage methods execution.
Definition: StorageWrappedTargetException.idl:29
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::packages::NoRawFormatException
This exception can be thrown in case provided stream is not a raw stream representing encrypted packa...
Definition: NoRawFormatException.idl:28
com::sun::star::packages::WrongPasswordException
This exception can be thrown in case wrong password was provided.
Definition: WrongPasswordException.idl:27
com::sun::star::embed::XOptimizedStorage
This is a temporary interface that is introduced to temporarily optimize the document storing process...
Definition: XOptimizedStorage.idl:29
com::sun::star::embed::XOptimizedStorage::copyElementDirectlyTo
void copyElementDirectlyTo([in] string sSourceName, [in] ::com::sun::star::embed::XOptimizedStorage xTargetStorage, [in] string sTargetName)
allows to copy storage element directly, not guaranteed to work.
com::sun::star::embed::XOptimizedStorage::insertStreamElementDirect
void insertStreamElementDirect([in] string sStreamName, [in] ::com::sun::star::io::XInputStream xInStream, [in] sequence< ::com::sun::star::beans::PropertyValue > aProperties)
allows to insert a stream to the storage directly.
com::sun::star::embed::XOptimizedStorage::attachToURL
void attachToURL([in] string sURL, [in] boolean bReadOnly)
allows to switch storage persistence to the provided URL.
com::sun::star::embed::XOptimizedStorage::getElementPropertyValue
any getElementPropertyValue([in] string sElementName, [in] string sPropertyName)
allows to get property of the child element with the specified name.
com::sun::star::embed::XOptimizedStorage::copyStreamElementData
void copyStreamElementData([in] string sStreamName, [in] ::com::sun::star::io::XStream xTargetStream)
fills the provided stream with the last flushed version of data from the child stream of the storage.
com::sun::star::embed::XOptimizedStorage::writeAndAttachToStream
void writeAndAttachToStream([in] ::com::sun::star::io::XStream xStream)
allows to switch storage persistence to the provided stream.
com::sun::star::embed::XOptimizedStorage::insertRawNonEncrStreamElementDirect
void insertRawNonEncrStreamElementDirect([in] string sStreamName, [in] ::com::sun::star::io::XInputStream xInStream)
allows to insert a raw stream representing non-encrypted stream with header.
com::sun::star::io::XInputStream
This is the basic interface to read data from a stream.
Definition: XInputStream.idl:30
com::sun::star::io::XStream
offers read and write access to the same stream.
Definition: XStream.idl:27
com
Definition: Ambiguous.idl:20