AOO410/main/udkapi/com/sun/star/lang/XTypeProvider.idl

/**************************************************************
 * 
 * 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
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/


#ifndef __com_sun_star_lang_XTypeProvider_idl__ 
#define __com_sun_star_lang_XTypeProvider_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_reflection_XIdlClass_idl__ 
#include <com/sun/star/reflection/XIdlClass.idl> 
#endif 
 
//============================================================================= 
 
module com {  module sun {  module star {  module lang {  
 
//============================================================================= 
 
/** interface to get information about the types 
	(usually interface types) supported by an object.
 */
published interface XTypeProvider: com::sun::star::uno::XInterface
{ 

	/** returns 
		a sequence of all types (usually interface types) provided by the object. 
		Important: If the object aggregates other objects the sequence also has  
		to contain all types supported by the aggregated objects.
	 */
	sequence<type> getTypes(); 
 
	 
	/** returns 
		a sequence of bytes with length > 0 that is used as an Id to distinguish
		unambiguously between two sets of types, e.g. to realise hashing 
		functionality when the object is introspected. Two objects that return 
		the same UUID also have to return the same set of types in getTypes(). 
		
		If a unique implementation Id cannot be provided this method has to return 
		an empty sequence.

		Important: If the object aggregates other objects the UUID has to be unique 
		for the whole combination of objects.
	 */
	sequence<byte> getImplementationId(); 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif