sl@0: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // This file contains the definition of the CResolver
sl@0: // class.
sl@0: // 
sl@0: //
sl@0: 
sl@0: #if defined (_MSC_VER) && (_MSC_VER >= 1000)
sl@0: #pragma once
sl@0: #endif
sl@0: #ifndef __RESOLVER_H__
sl@0: #define __RESOLVER_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <f32file.h>
sl@0: 
sl@0: #include <ecom/ecom.h>
sl@0: #include <ecom/publicregistry.h>
sl@0: 
sl@0: class TEComResolverParams;
sl@0: 
sl@0: /**
sl@0: The UID idnetifying the ECOM Resolver plugin interface.
sl@0: 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: const TUid KCustomResolverInterfaceUid = {0x10009D90};
sl@0: 
sl@0: /**
sl@0: Abstract base class which is used to identify the correct interface implementation
sl@0: based on criteria supplied by the client.
sl@0: This base class can be used to write a client specific resolver, however this is not 
sl@0: required as a default implementation is provided within ECom.
sl@0: 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 
sl@0: class CResolver : public CBase
sl@0: {
sl@0: public:
sl@0: 	/**
sl@0: 	Intended Usage	:	Request that the resolver identify the most appropriate interface 
sl@0: 						implementation.
sl@0: 	Error Condition	:	Depends on implementation.
sl@0: 	@since			7.0
sl@0: 	@param			aInterfaceUid The interface for which an implementation is requested
sl@0: 	@param			aAdditionalParameters The parameters which must match for an 
sl@0: 					implementation to be suitable
sl@0: 	@return			The unique Id of the implementation which satisfies the specified parameters.
sl@0: 	@pre 			This object is fully constructed.
sl@0:  	*/
sl@0: 	
sl@0: 	virtual TUid IdentifyImplementationL(TUid aInterfaceUid, 
sl@0: 										 const TEComResolverParams& aAdditionalParameters) const  = 0;
sl@0: 
sl@0: 	/**
sl@0: 	Intended Usage	:	List all the implementations which satisfy the specified 
sl@0: 						interface definition and the resolve parameters supplied.
sl@0: 	Error Condition	:	Depends on implementation.
sl@0: 	@since			7.0
sl@0: 	@param			aInterfaceUid The interface for which implementations are requested
sl@0: 	@param			aAdditionalParameters The parameters which must match for an 
sl@0: 					implementation to be suitable
sl@0: 	@return			Pointer to an array of suitable implementations. Ownership of this 
sl@0: 					array is passed to the calling function.
sl@0: 	@pre 			Object is fully constructed and initialized
sl@0: 	@post			Registry contents are not modified but registry keys may be updated
sl@0: 	*/
sl@0: 	
sl@0: 	virtual RImplInfoArray* ListAllL(TUid aInterfaceUid, 
sl@0: 									 const TEComResolverParams& aAdditionalParameters) const = 0;
sl@0: 
sl@0: 	
sl@0: 	inline RImplInfoArray& ListAllL(TUid aInterfaceUid)const;
sl@0: 
sl@0: protected:
sl@0: 	
sl@0: 	explicit inline CResolver(MPublicRegistry& aRegistry);
sl@0: 
sl@0: 	// Attributes
sl@0: 	/** A reference to the instantiated registry information */
sl@0: 	
sl@0: 	 const MPublicRegistry& iRegistry;
sl@0: };
sl@0: 
sl@0: /**
sl@0: @internalAll
sl@0: Intended Usage	: Standardized default c'tor
sl@0: Error Condition	: None
sl@0: @since			7.0
sl@0: @post			CResolver is fully constructed
sl@0: */
sl@0: CResolver::CResolver(MPublicRegistry& aRegistry) :
sl@0: CBase(),
sl@0: iRegistry(aRegistry)
sl@0: 	{
sl@0: 	// Do nothing
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Intended Usage	:	List all the implementations which satisfy the specified interface.
sl@0: Error Condition	:	@see CRegistryData::ListImplementationsL
sl@0: @since			7.0
sl@0: @param			aInterfaceUid The interface for which implementations are requested
sl@0: @return			Array of suitable implementations
sl@0: @pre 			Object is fully constructed and initialized
sl@0: @post			Registry contents are not modified but registry keys may be updated
sl@0: */
sl@0: RImplInfoArray& CResolver::ListAllL(TUid aInterfaceUid)const
sl@0: 	{
sl@0: 	return iRegistry.ListImplementationsL(aInterfaceUid);
sl@0: 	}
sl@0: 
sl@0: #endif /* __RESOLVER_H__ */
sl@0: