1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_embed_XClassifiedObject_idl__
24#define __com_sun_star_embed_XClassifiedObject_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_lang_NoSupportException_idl__
31#include <com/sun/star/lang/NoSupportException.idl>
32#endif
33
34
35//============================================================================
36
37 module com {  module sun {  module star {  module embed {
38
39//============================================================================
40/** represents common functionality for embedded objects
41 */
42published interface XClassifiedObject: com::sun::star::uno::XInterface
43{
44	// -----------------------------------------------------------------------
45    /** retrieves class ID of the object.
46
47		@return
48			unique class ID of the object
49	 */
50	sequence< byte > getClassID();
51
52	// -----------------------------------------------------------------------
53    /** retrieves symbolic name for the object type to be used in UI.
54
55		@return
56			the symbolic name for the object
57	 */
58	string getClassName();
59
60	// -----------------------------------------------------------------------
61    /** sets the class ID and symbolic name to an object.
62
63		@param aClassID
64			the new class ID
65
66		@param sClassName
67			the new symbolic name
68
69		@throws ::com::sun::star::lang::NoSupportException
70			in case changing of class information is not allowed
71	 */
72	void setClassInfo(  [in] sequence< byte > aClassID,
73						[in] string sClassName )
74		raises( ::com::sun::star::lang::NoSupportException );
75};
76
77//=============================================================================
78
79}; }; }; };
80
81#endif
82
83