IK2ServiceRegistry.h

//========================================================================================
// 
// $File$
// 
// Owner: Zak_Williamson
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Purpose:
// The IK2ServiceRegistry interface lives on the session boss. The 
// service registry provides a globally accessible container where 
// non-persistent bosses can be registered as providing a "service". 
// A ServiceID (a long integer in K2's ID space) is used to categorize 
// a set of non-persistent boss objects that support the same set of 
// interfaces.
// 
// To provide a service, a boss object only needs to aggregate an 
// IK2ServiceProvider interface. The remainder of the interfaces of the 
// boss can be whatever the developer needs to a specific task. The 
// service registry will automatically find and register the boss as a 
// service during startup.
// 
// Examples of services include: import filters, export filters, open 
// converters, text composers, dialog panels, actions to run when creating 
// a new document, actions to run at application startup/shutdown, image data
// manipulators, hyphenation systems, spelling systems, measurement systems, etc. 
// 
//========================================================================================

#ifndef __IK2ServiceRegistry__
#define __IK2ServiceRegistry__

#include "IPMUnknown.h"
#include "ShuksanID.h"

class IK2ServiceProvider;

class IK2ServiceRegistry : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IK2SERVICEREGISTRY };

 virtual IK2ServiceProvider * QueryServiceProviderByClassID(ServiceID serviceID, ClassID providerClassID) const= 0;

 virtual IK2ServiceProvider * QueryDefaultServiceProvider(ServiceID serviceID) const= 0;

 virtual ClassID GetDefaultServiceProviderID(ServiceID serviceID) const = 0;
 
 virtual void SetDefaultServiceProviderID(ServiceID serviceID, ClassID classID) = 0;
 




 virtual int32 GetServiceProviderCount(ServiceID serviceID) const= 0;
 
 virtual IK2ServiceProvider * QueryNthServiceProvider(ServiceID serviceID, int32 n) const= 0;

 virtual ClassID GetNthServiceProviderID(ServiceID serviceID, int32 n) const= 0;

 virtual int32 GetServiceProviderIndex(ServiceID serviceID, ClassID serviceProviderID) const= 0;

 virtual int32 GetServiceProviderIndex(const IK2ServiceProvider * serviceProvider) const= 0;






 virtual void Startup() = 0;

 virtual void Shutdown() = 0;
 
 virtual void ReleaseCachedServiceProviders() = 0;
 
 virtual void RegisterServiceProvider(ClassID classID) = 0;

 virtual void PerformStartupServices() = 0;

 virtual void GetRegisteredServiceIDs(K2Vector<ServiceID>& services) const= 0;


};

#endif