ILibraryScrapController.h

//========================================================================================
// 
// $File$
// 
// Owner: Mark VerMurlen
// 
// $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.
// 
// 
// Reviewed: 9/25/98
// 
// Purpose:
// This interface is responsible for managing the Library Panel's Scrap.
// 
//========================================================================================

#ifndef __ILibraryScrapController__
#define __ILibraryScrapController__

#include "CDataExchangeController.h"
#include "ShuksanID.h"


class IDataExchangeHandler;
class IDataBase;
class ILibraryAsset;

class ILibraryScrapController : public CDataExchangeController
{
 // ----- Constructor/Destructor
 public:
 ILibraryScrapController(IPMUnknown *boss) : CDataExchangeController(boss) {};
 virtual ~ILibraryScrapController() {};

 // ----- Active handler
 public:
 virtual IDataExchangeHandler* QueryHandlerForInternalize(DataExchangeResponse& response, const PMFlavor& internalizedFlavor = kNoFlavor) const = 0;

 // ----- Scrap Conversion
 public:
 virtual bool16 NeedsToInternalize() const = 0;

 virtual ErrorCode ExternalizeToLibrary() const = 0;

 virtual ErrorCode InternalizeFromLibrary() = 0;

 virtual ErrorCode InternalizeFromOldLibrary() = 0;

 virtual ErrorCode FulfillPromise(IPMDataObject* whichItem, const ExternalPMFlavor& whichFlavor) const = 0;

 virtual ErrorCode Clear() = 0;
 
 virtual void SetWorkingLibraryAsset( ILibraryAsset *libraryAsset ) = 0;

 virtual void Cleanup() = 0;
};

#endif