/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */


 module com {  module sun {  module star {  module embed {

/** specifies an implementation for embedded object persistence.
    <p>
    The idea is that any usable embedded object should be initialized
    with an entry in the parent storage that will be used as persistent
    representation.
    </p>
 */
published interface XEmbedPersist: XCommonEmbedPersist
{
    /** provides object with a parent storage and a name for object's entry.

        <p>
        An entry with the specified name should be created/opened inside
        provided storage. It can be a storage or a stream. For example,
        OOo API will refer to OLE storages only by streams, but the object
        implementation will use storage based on this stream.
        </p>

        <p>
        Factory does this call to initialize the embedded object.
        The linked object can be initialized by factory in different way
        ( internally ).
        </p>

        <p>
        It is also possible to switch object persistent representation through
        this call. Actually this is the way, this call can be used by user
        ( since initialization is done by factory ).
        </p>

        @param xStorage
            a parent storage the entry should be created in

        @param sEntName
            a name for the entry

        @param nEntryConnectionMode
            a mode in which the object should be initialized from entry
            can take values from EntryInitModes constant set

        @param aMediaArgs
            optional parameters for the embedded document persistence
            initialization, see also
            com::sun::star::document::MediaDescriptor

        @param aObjectArgs
            optional parameters for the object persistence initialization,
            see also
            com::sun::star::embed::EmbeddedObjectDescriptor

        @throws ::com::sun::star::lang::IllegalArgumentException
            one of arguments is illegal

        @throws com::sun::star::embed::WrongStateException
            the object is in wrong state

        @throws com::sun::star::io::IOException
            in case of io problems during opening or creation

        @throws com::sun::star::uno::Exception
            in case of other problems
     */
    void setPersistentEntry(
            [in] ::com::sun::star::embed::XStorage xStorage,
            [in] string sEntName,
            [in] long nEntryConnectionMode,
            [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
            [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
        raises( ::com::sun::star::lang::IllegalArgumentException,
                ::com::sun::star::embed::WrongStateException,
                ::com::sun::star::io::IOException,
                ::com::sun::star::uno::Exception );

    /** lets the object store itself to an entry in destination storage,
        the own persistence entry is not changed.

        @param xStorage
            a parent storage the entry should be created inside

        @param sEntName
            a name for the entry

        @param aMediaArgs
            optional parameters for document saving, see also
            com::sun::star::document::MediaDescriptor

        @param aObjectArgs
            optional parameters for the object saving, see also
            com::sun::star::embed::EmbeddedObjectDescriptor

        @throws ::com::sun::star::lang::IllegalArgumentException
            one of arguments is illegal

        @throws com::sun::star::embed::WrongStateException
            the object is in wrong state

        @throws com::sun::star::io::IOException
            in case of io problems during storing

        @throws com::sun::star::uno::Exception
            in case of other problems
     */
    void storeToEntry(
            [in] ::com::sun::star::embed::XStorage xStorage,
            [in] string sEntName,
            [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
            [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
        raises( ::com::sun::star::lang::IllegalArgumentException,
                ::com::sun::star::embed::WrongStateException,
                ::com::sun::star::io::IOException,
                ::com::sun::star::uno::Exception );

    /** lets the object store itself to an entry in destination storage and
        prepare to use the new entry for own persistence.

        <p>
        The object should be stored to the new entry, after that the entry
        should be remembered by the object. After the storing process is
        finished the XEmbedPersist::saveCompleted() method
        can be used to specify whether the object should use the new entry or
        the old one. The object persistence can not be used until
        XEmbedPersist::saveCompleted() is called.
        So this state can be treated as "HandsOff" state.
        <p>

        @param xStorage
            a parent storage the entry should be created in

        @param sEntName
            a name for the entry

        @param aMediaArgs
            optional parameters for document saving, see also
            com::sun::star::document::MediaDescriptor

        @param aObjectArgs
            optional parameters for the object saving, see also
            com::sun::star::embed::EmbeddedObjectDescriptor

        @throws ::com::sun::star::lang::IllegalArgumentException
            one of arguments is illegal

        @throws com::sun::star::embed::WrongStateException
            the object is in wrong state

        @throws com::sun::star::io::IOException
            in case of io problems during storing

        @throws com::sun::star::uno::Exception
            in case of other problems
     */
    void storeAsEntry(
            [in] ::com::sun::star::embed::XStorage xStorage,
            [in] string sEntName,
            [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
            [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
        raises( ::com::sun::star::lang::IllegalArgumentException,
                ::com::sun::star::embed::WrongStateException,
                ::com::sun::star::io::IOException,
                ::com::sun::star::uno::Exception );


    /** specifies whether the object should use an old storage or a new one
        after "save as" operation.

        @param bUseNew
            `TRUE` the new storage should be used
            `FALSE` the old one

        @throws com::sun::star::embed::WrongStateException
            the object is in wrong state

        @throws com::sun::star::uno::Exception
            in case of other problems
     */

    void saveCompleted( [in] boolean bUseNew )
        raises( ::com::sun::star::embed::WrongStateException,
                ::com::sun::star::uno::Exception );

    /** allows to detect if the object has entry.

        @returns
            `TRUE` if the object has own entry set
            `FALSE` otherwise
     */
    boolean hasEntry()
        raises( ::com::sun::star::embed::WrongStateException );

    /** allows to retrieve the current object entry name.

        @returns
            the object entry name if any

        @throws com::sun::star::embed::WrongStateException
            the object is in wrong state ( has no entry )
     */
    string getEntryName()
        raises( ::com::sun::star::embed::WrongStateException );
};


}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
