offapi/com/sun/star/embed/XHierarchicalStorageAccess2.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 #ifndef __com_sun_star_embed_XHierarchicalStorageAccess2_idl__
  20 #define __com_sun_star_embed_XHierarchicalStorageAccess2_idl__
  21
  22 #include <com/sun/star/embed/XHierarchicalStorageAccess.idl>
  23 #include <com/sun/star/beans/NamedValue.idl>
  24
  25
  26  module com {  module sun {  module star {  module embed {
  27
  28 /** This interface extends XHierarchicalStorageAccess interface.
  29  */
  30 interface XHierarchicalStorageAccess2 : XHierarchicalStorageAccess
  31 {
  32     /** allows to get access to a child encrypted stream with encryption data
  33         using hierarchical path.
  34
  35         <p>
  36         If storage does not allow any encryption this method will always throw
  37         com::sun::star::packages::NoEncryptionException.
  38         </p>
  39
  40         <p>
  41         In case the stream is open in readonly mode the
  42         com::sun::star::io::XStream::getOutputStream()
  43         method will return an empty reference.
  44         </p>
  45
  46         @param sStreamName
  47             the path to the substream that should be open
  48
  49         @param nOpenMode
  50             a mode the stream should be open in,
  51             can be a combination of ElementModes values
  52
  53         @param aEncryptionData
  54             this parameter allowes to specify an encryption data for the
  55             stream, the data must be correct, otherwise an
  56             exception will be thrown
  57
  58         @throws ::com::sun::star::embed::InvalidStorageException
  59             this storage is in invalid state for any reason
  60
  61         @throws ::com::sun::star::lang::IllegalArgumentException
  62             one of provided arguments is illegal
  63
  64         @throws ::com::sun::star::packages::NoEncryptionException
  65             the stream is not encrypted
  66
  67         @throws ::com::sun::star::packages::WrongPasswordException
  68             the provided password is wrong
  69
  70         @throws ::com::sun::star::io::IOException
  71             in case of io errors during stream opening
  72
  73         @throws ::com::sun::star::embed::StorageWrappedTargetException
  74             wraps other exceptions
  75      */
  76     XExtendedStorageStream  openEncryptedStreamByHierarchicalName(
  77             [in] string sStreamName,
  78             [in] long nOpenMode,
  79             [in] sequence< ::com::sun::star::beans::NamedValue > aEncryptionData )
  80         raises( ::com::sun::star::embed::InvalidStorageException,
  81                 ::com::sun::star::lang::IllegalArgumentException,
  82                 ::com::sun::star::packages::NoEncryptionException,
  83                 ::com::sun::star::packages::WrongPasswordException,
  84                 ::com::sun::star::container::NoSuchElementException,
  85                 ::com::sun::star::io::IOException,
  86                 ::com::sun::star::embed::StorageWrappedTargetException );
  87 };
  88
  89
  90 }; }; }; };
  91
  92 #endif
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */