ILibraryCmdUtils.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 used to create and process the various commands of the Library.
// 
//========================================================================================

#ifndef __LibraryCmdUtils__
#define __LibraryCmdUtils__

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

class UIDList;
class ICommand;
class ILibrary;
class IDocument;
class IDataExchangeHandler;
class XMLReference;
class UIDRef;

class ILibraryCmdUtils : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_ILIBRARYCMDUTILS};

 static ILibraryCmdUtils* QueryLibraryCmdUtils() { return Utils<ILibraryCmdUtils>().QueryUtilInterface() ; }

 // Create the various Library Commands

 virtual ICommand* CreateLibraryAddItemCmd(UIDList *selection, ILibrary *library, bool16 fromCompletePage = false ) = 0;

 virtual ICommand* CreateLibraryUpdateItemCmd(UIDList *selection, ILibrary *library, const AssetIDList &assetList ) = 0;

 virtual ICommand* CreateLibraryCopyItemsCmd(const AssetIDList &sourceAssetList,
 ILibrary *sourceLibrary, ILibrary *destLibrary ) = 0;

 virtual ICommand* CreateLibraryDeleteItemsCmd(const AssetIDList &assetList, ILibrary *library ) = 0;

 virtual ICommand* CreateLibraryNewLibCmd( const IDFile &libraryFile ) = 0;

 virtual ICommand* CreateLibraryOpenLibCmd( const IDFile &libraryFile ) = 0;

 virtual ICommand* CreateLibraryCloseLibCmd( ILibrary *library ) = 0; 
 
 virtual ErrorCode ProcessLibraryAddItemCmd(UIDList *selection, ILibrary *library, 
 bool16 fromCompletePage = false, AssetIDList* newAssetList = nil,
 IDataExchangeHandler *handler = nil, ExternalPMFlavor gotFlavor = kNoFlavor) = 0;

 virtual ErrorCode ProcessLibraryAddStructureCmd(XMLReference& addThis, ILibrary *library, 
 AssetIDList* newAssetList = nil, IDataExchangeHandler *handler = nil, ExternalPMFlavor gotFlavor = kNoFlavor) = 0;

 virtual ErrorCode ProcessLibraryUpdateItemCmd(UIDList *selection, ILibrary *library, 
 AssetIDList* newAssetList = nil,
 IDataExchangeHandler *handler = nil, ExternalPMFlavor gotFlavor = kNoFlavor) = 0;

 virtual ErrorCode ProcessLibraryUpdateStructureCmd(XMLReference& addThis, ILibrary *library, 
 AssetIDList* assetList = nil, IDataExchangeHandler *handler = nil, ExternalPMFlavor gotFlavor = kNoFlavor) = 0;

 virtual ErrorCode ProcessLibraryCopyItemsCmd(const AssetIDList &sourceAssetList,
 ILibrary *sourceLibrary, ILibrary *destLibrary ) = 0;

 virtual ErrorCode ProcessLibraryDeleteItemsCmd(const AssetIDList &assetList, ILibrary *library ) = 0;

 // See ILibrarySuite for these functions:
#if 0
 virtual ErrorCode ProcessLibraryPlaceItemsCmd(const AssetIDList &assetList, 
 ILibrary *library,
 UIDList& out_placedItemList,
 IDocument* inDocument = nil) = 0; 

 virtual ErrorCode ProcessLibraryPlaceItemsCmd(const AssetIDList &assetList, 
 ILibrary *library,
 IDocument* inDocument = nil) = 0;
#endif

 virtual ErrorCode ProcessLibraryNewLibCmd( const IDFile &libraryFile ) = 0;

 virtual ErrorCode ProcessLibraryOpenLibCmd( const IDFile &libraryFile, UIDRef *openedLib = nil ) = 0;
 
 virtual ErrorCode ScheduleLibraryCloseLibCmd( ILibrary *library ) = 0;

 virtual ErrorCode OpenLibraryWithUI(const IDFile& sysFile, UIDRef *openedLib = nil) = 0;
};


#endif