/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_embed_XEmbedObjectCreator_idl__
#define __com_sun_star_embed_XEmbedObjectCreator_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_embed_XStorage_idl__
#include <com/sun/star/embed/XStorage.idl>
#endif

#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif

#ifndef __com_sun_star_embed_WrongStateException_idl__
#include <com/sun/star/embed/WrongStateException.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif

//============================================================================

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

//============================================================================
/** allows to create and initialize a new embedded object.

    <p>
    This interface contains methods that can help to create and initialize
    an embedded object.
    </p>
 */
published interface XEmbedObjectCreator: com::sun::star::uno::XInterface
{
    // -----------------------------------------------------------------------
    /** creates a new object and initializes it as a new one.

        <p> In case specified entry exists it's contents are ignored and
        will be overwritten on storing.
        </p>

        @param aClassID
            the class id of the new object

        @param sClassName
            the class name of the new object

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

        @param sEntryName
            a name for the entry

        @param aObjectArgs
            optional parameters for the object persistence initialization
            see also 
            <type>EmbeddedObjectDescriptor</type>

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

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

        @throws com::sun::star::uno::Exception
            in case of other problems
     */
    ::com::sun::star::uno::XInterface createInstanceInitNew(
            [in] sequence< byte > aClassID,
            [in] string sClassName,
            [in] ::com::sun::star::embed::XStorage xStorage,
             [in] string sEntryName,
            [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
        raises( ::com::sun::star::lang::IllegalArgumentException,
                ::com::sun::star::io::IOException,
                ::com::sun::star::uno::Exception );


    // -----------------------------------------------------------------------
    /** creates a new object that should be based on specified storage entry.

        <p> The specified entry must exists and the object should be loaded
        from the entry. In case a persistent representation of a link is
        specified, the result object will be a link.
        </p>
        
        @param xStorage
            a parent storage the entry should be opened in

        @param sEntryName
            a name for the entry

        @param aMediaDescriptor
            an object of type
            <type scope="com::sun::star::document">MediaDescriptor</type> that
            specifies document related properties; please remember that target
            related parameters, for example URL, will be ignored since the
            object should be loaded from storage entry

        @param aObjectArgs
            an object of type <type>EmbeddedObjectDescriptor</type>
            contains object related properties

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

        @thrown ::com::sun::star::container::NoSuchElementException
            the specified entry does not exist

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

        @throws com::sun::star::uno::Exception
            in case of other problems
     */
    ::com::sun::star::uno::XInterface createInstanceInitFromEntry(
            [in] ::com::sun::star::embed::XStorage xStorage,
            [in] string sEntryName,
            [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor,
            [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
        raises( ::com::sun::star::lang::IllegalArgumentException,
                ::com::sun::star::container::NoSuchElementException,
                ::com::sun::star::io::IOException,
                ::com::sun::star::uno::Exception );

    // -----------------------------------------------------------------------
    /** creates a new object and initializes it based on
        <type scope="com::sun::star::document">MediaDescriptor</type>.

        <p> In case specified entry exists it's contents are ignored and will
        be overwritten on storing.
        </p>
        
        @param xStorage
            a parent storage the entry should be created/opened in

        @param sEntryName
            a name for the entry

        @param aMediaDescriptor
            an object of type
            <type scope="com::sun::star::document">MediaDescriptor</type> that
            specifies source

        @param aObjectArgs
            an object of type <type>EmbeddedObjectDescriptor</type>
            contains object related properties

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

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

        @throws com::sun::star::uno::Exception
            in case of other problems
     */
    ::com::sun::star::uno::XInterface createInstanceInitFromMediaDescriptor(
            [in] ::com::sun::star::embed::XStorage xStorage,
            [in] string sEntryName,
             [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor,
            [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
        raises( ::com::sun::star::lang::IllegalArgumentException,
                ::com::sun::star::io::IOException,
                ::com::sun::star::uno::Exception );
};

//============================================================================

}; }; }; };

#endif

