ILibraryScrapUtils.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 assisting the Library Panel's Scrap Controller.
// 
//========================================================================================

#ifndef __ILibraryScrapUtils__
#define __ILibraryScrapUtils__

#include "IPMUnknown.h"
#include "LibraryAssetID.h"
#include "LibraryProviderID.h"
#include "PMFlavorTypes.h"

class ILibrary;
class ILibraryAsset;
class UIDList;
class IDataBase;
class IDataExchangeHandler;
class XMLReference;

class ILibraryScrapUtils : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_ILIBRARYSCRAPUTILS};

 virtual LibraryAssetID ConvertToLibraryAsset(const UIDList *originalPageItems,
 const UIDList *libraryScrapPageItems, ILibrary* library,
 bool16 fromCompletePage = false) = 0;

 virtual LibraryAssetID ConvertToAssetUsingSnippets(ILibrary *library, UIDList *itemList,
 IDataExchangeHandler *handler, ExternalPMFlavor gotFlavor) = 0;

 virtual ErrorCode UpdateItemAsset(ILibrary *library, ILibraryAsset* asset, UIDList *itemList,
 IDataExchangeHandler *handler, ExternalPMFlavor gotFlavor) = 0;

 virtual ErrorCode UpdateStructureAsset(ILibrary *library, ILibraryAsset* asset, XMLReference& fromThis,
 IDataExchangeHandler *handler, ExternalPMFlavor gotFlavor) = 0;

 virtual LibraryAssetID ConvertStructureToAssetUsingSnippets(ILibrary *library, XMLReference& addThis,
 IDataExchangeHandler *handler, ExternalPMFlavor gotFlavor) = 0;

 virtual bool16 IsScrapDB(IDataBase* db) = 0;
};

#endif