CDataExchHandler_Extensible.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Burnard
// 
// $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.
// 
// 
// base class implementation for extensible DataExchangeHandlers
// 
//========================================================================================

#ifndef __CDataExchangeHandler_Extensible__
#define __CDataExchangeHandler_Extensible__

#include "IDataExchangeHandler.h"
#include "PMFlavorTypes.h"
#include "HelperInterface.h"

#include "IDataExchHandlerFlavorHelper.h"


class CDataExchangeHandler_Extensible : public IDataExchangeHandler
{
 public:
 CDataExchangeHandler_Extensible(IPMUnknown *boss);
 virtual ~CDataExchangeHandler_Extensible();
 
 public:
 // ----- Initialization
 virtual void CreateScrapStorage() = 0;
 // Call this to create storage for the scrap in a new database.

 // ----- Extensibility
 virtual ServiceID GetDEHandlerHelperServiceID() const = 0;

 // ----- Abilities
 enum eActionType {kInternalizeFlavorAction, kExternalizeFlavorAction};
 
 public:
 virtual void Clear() = 0;
 virtual bool16 IsEmpty() const = 0;
 
 // Return the Internal flavor (data type) this handler deals with.
 virtual PMFlavor GetFlavor() const = 0;
 
 virtual DataExchangeResponse CanInternalizeData(IPMDataObject* whichItem) const;
 virtual bool16 CanConvertExternalFlavor(ExternalPMFlavor fromWhichFlavor) const;
 virtual void AddInternalizeableFlavorsToList(OrderedFlavorList& flavorList) const;
 virtual void AddExternalizeableFlavorsToList(OrderedFlavorList& flavorList) const;

 // ----- Conversion to platform data exchange
 public:
 virtual ErrorCode ExternalizePromises(IPMDataObject* whichItem);
 virtual ErrorCode Externalize(IPMDataObject* whichItem, ExternalPMFlavor toWhichFlavor, IPMStream* s);
 virtual ErrorCode Internalize(IPMDataObject* whichItem);
 virtual ErrorCode Internalize(IPMDataObject* whichItem, ExternalPMFlavor fromWhichFlavor, IPMStream* s);

 protected:
 ErrorCode Delegate_ExternalizePromises(IPMDataObject* whichItem, OrderedPromiseList& orderedPromiseList);

 IDataExchangeHandlerFlavorHelper* QueryBestHelperForInternalize(IPMDataObject* whichItem, DataExchangeResponse& bestHelperResponse) const;
 IDataExchangeHandlerFlavorHelper* QueryHelper_ForAction(eActionType action, ExternalPMFlavor whichFlavor, DataExchangeResponse& bestHelperResponse) const;

 private:
 
};


#endif