/*************************************************************************
 *
 * 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_XClassifiedObject_idl__
#define __com_sun_star_embed_XClassifiedObject_idl__

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

#ifndef __com_sun_star_lang_NoSupportException_idl__
#include <com/sun/star/lang/NoSupportException.idl>
#endif


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

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

//============================================================================
/** represents common functionality for embedded objects
 */
interface XClassifiedObject: com::sun::star::uno::XInterface
{
    // -----------------------------------------------------------------------
    /** retrieves class ID of the object.

        @return
            unique class ID of the object
     */
    sequence< byte > getClassID();

    // -----------------------------------------------------------------------
    /** retrieves symbolic name for the object type to be used in UI.

        @return
            the symbolic name for the object
     */
    string getClassName();

    // -----------------------------------------------------------------------
    /** sets the class ID and symbolic name to an object.

        @param aClassID
            the new class ID

        @param sClassName
            the new symbolic name

        @throws ::com::sun::star::lang::NoSupportException
            in case changing of class information is not allowed
     */
    void setClassInfo(  [in] sequence< byte > aClassID,
                        [in] string sClassName )
        raises( ::com::sun::star::lang::NoSupportException );
};

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

}; }; }; };

#endif