/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XClassifiedObject.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 00:09:07 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#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

