ILibraryAssetCollection.h

//========================================================================================
// 
// $File$
// 
// Owner: 
// 
// $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:
// This interface is a secondary interface to the Library Boss. This interface
// controls the "collection" of assets that make up the Library. Use this
// interface to add and remove assets from the Library.
// 
//========================================================================================

#ifndef __ILibraryAssetCollection__
#define __ILibraryAssetCollection__

#include "IPMUnknown.h"
#include "LibraryProviderID.h"


class ILibraryAsset;
class ILibraryAssetIterator;
class ILibraryComplexFilterData;
class LibraryAssetID;

class ILibraryAssetCollection : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ILIBRARYASSETCOLLECTION };

 virtual ILibraryAsset* AcquireNewAsset() = 0;
 
 virtual ILibraryAsset* AcquireAssetCopy(ILibraryAsset* sourceAsset) = 0;
 
 virtual ILibraryAsset* AcquireAsset(const LibraryAssetID& id) = 0;
 
 virtual void ReleaseAsset( ILibraryAsset* asset, bool16 assetWasChanged = kTrue, bool16 bForce = kFalse ) = 0;
 
 virtual void RemoveAsset(const LibraryAssetID& id) = 0;
 
 virtual bool16 IsOpen() const = 0;
 
 virtual bool16 IsLocked() const = 0;
 
 virtual ILibraryAssetIterator* CreateIteratorWithFilter(ILibraryComplexFilterData* inFilter) = 0;
 
 virtual int32 Length() const = 0; 
 
 //-------------- For Internal Use Only -------------------------
 
 // Opens the collection with the given pathname
 virtual bool16 Open( const IDFile &libraryFile ) = 0;
 
 // Creates a new collection with the given pathname
 virtual bool16 Create( const IDFile &libraryFile ) = 0;
 
 // Closes the collection.
 virtual void Close() = 0;
 
 // Disable and Enable Notification of Library Open and Close events
 virtual void DisableLibraryLevelNotification() = 0;
 virtual void EnableLibraryLevelNotification() = 0;
 
 // Disable and Enable Notification of Asset Addition, Change, and Deletion events
 virtual void DisableAssetLevelNotification() = 0;

 virtual void EnableAssetLevelNotification() = 0;
 
 // Get, Set, and Test the status of the "Has Changed" flag
 virtual void ClearHasChangedStatus() = 0;

 virtual void SetHasChangedStatus() = 0;

 virtual bool16 HasChanged() = 0;

 // Tell whether the library is old and needs to be converted to snippet data store
 virtual bool16 NeedsSnippetConversion( const IDFile &libraryFile ) = 0;

 // Converts the input library file to snippet data storage format
 virtual bool16 ConvertToSnippets( const IDFile &oldLibraryFile, IDFile &tmpLibraryFile, IDFile &newLibraryFile, bool16 bUseOldName = kFalse ) = 0;
 
};


#endif