ILibraryAssetCollection Class Reference

#include <ILibraryAssetCollection.h>

Inheritance diagram for ILibraryAssetCollection:

Public Types
enum	{ kDefaultIID = IID_ILIBRARYASSETCOLLECTION }

Public Member Functions
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
virtual bool16	Open (const IDFile &libraryFile)=0
virtual bool16	Create (const IDFile &libraryFile)=0
virtual void	Close ()=0
virtual void	DisableLibraryLevelNotification ()=0
virtual void	EnableLibraryLevelNotification ()=0
virtual void	DisableAssetLevelNotification ()=0
virtual void	EnableAssetLevelNotification ()=0
virtual void	ClearHasChangedStatus ()=0
virtual void	SetHasChangedStatus ()=0
virtual bool16	HasChanged ()=0
virtual bool16	NeedsSnippetConversion (const IDFile &libraryFile)=0
virtual bool16	ConvertToSnippets (const IDFile &oldLibraryFile, IDFile &tmpLibraryFile, IDFile &newLibraryFile, bool16 bUseOldName=kFalse)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

A secondary interface to the Library boss, this controls the "collection" of assets that make up the library. Use this to add and remove assets from the library.

Member Function Documentation

virtual ILibraryAsset* ILibraryAssetCollection::AcquireAsset ( const LibraryAssetID &  id )

pure virtual

Gets the asset with the given id and returns a pointer to it. You must later release the asset.

Parameters

id	IN the LibraryAssetID for the asset to get

Returns

the ILibraryAsset pointer for the asset

virtual ILibraryAsset* ILibraryAssetCollection::AcquireAssetCopy ( ILibraryAsset *  sourceAsset )

pure virtual

Adds a new asset to the collection by copying an existing asset and returns a pointer to the new copy. You must later release the copied asset.

Parameters

sourceAsset

IN the asset to copy

Returns

an interface pointer to the new ILibraryAsset

virtual ILibraryAsset* ILibraryAssetCollection::AcquireNewAsset ( )

pure virtual

Adds a new empty asset to the collection and returns a pointer to it. You must later release the asset.

Returns

the ILibraryAsset pointer

virtual void ILibraryAssetCollection::ClearHasChangedStatus ( )

pure virtual

• For Internal Use Only *

virtual void ILibraryAssetCollection::Close ( )

pure virtual

• For Internal Use Only *

virtual bool16 ILibraryAssetCollection::ConvertToSnippets ( const IDFile &  oldLibraryFile, IDFile &  tmpLibraryFile, IDFile &  newLibraryFile, bool16  bUseOldName = kFalse  )

pure virtual

• For Internal Use Only *

virtual bool16 ILibraryAssetCollection::Create ( const IDFile &  libraryFile )

pure virtual

• For Internal Use Only *

virtual ILibraryAssetIterator* ILibraryAssetCollection::CreateIteratorWithFilter ( ILibraryComplexFilterData *  inFilter )

pure virtual

Returns an iterator to traverse the assets in the collection.

Parameters

IN	inFilter information about how to filter; pass nil to see all assets

Returns

an interface pointer to ILibraryAssetIterator

virtual void ILibraryAssetCollection::DisableAssetLevelNotification ( )

pure virtual

• For Internal Use Only *

virtual void ILibraryAssetCollection::DisableLibraryLevelNotification ( )

pure virtual

• For Internal Use Only *

virtual void ILibraryAssetCollection::EnableAssetLevelNotification ( )

pure virtual

• For Internal Use Only *

virtual void ILibraryAssetCollection::EnableLibraryLevelNotification ( )

pure virtual

• For Internal Use Only *

virtual bool16 ILibraryAssetCollection::HasChanged ( )

pure virtual

• For Internal Use Only *

virtual bool16 ILibraryAssetCollection::IsLocked ( ) const

pure virtual

Get whether the collection is locked (no changes can be made).

Returns

kTrue if locked, kFalse otherwise

virtual bool16 ILibraryAssetCollection::IsOpen ( ) const

pure virtual

Get whether the collection is open.

Returns

kTrue if the collection is open, kFalse otherwise

virtual int32 ILibraryAssetCollection::Length ( ) const

pure virtual

Get the total number of assets in collection.

Returns

the collection length

virtual bool16 ILibraryAssetCollection::NeedsSnippetConversion ( const IDFile &  libraryFile )

pure virtual

• For Internal Use Only *

virtual bool16 ILibraryAssetCollection::Open ( const IDFile &  libraryFile )

pure virtual

• For Internal Use Only *

virtual void ILibraryAssetCollection::ReleaseAsset ( ILibraryAsset *  asset, bool16  assetWasChanged = kTrue, bool16  bForce = kFalse  )

pure virtual

Releases the asset. If the assetWasChanged flag is true, observers will be notified that the asset has changed.

Parameters

asset	IN an interface pointer to the asset to release
assetWasChanged	IN kTrue to notify observers, kFalse otherwise
bForce	IN * For Internal Use Only *

virtual void ILibraryAssetCollection::RemoveAsset ( const LibraryAssetID &  id )

pure virtual

Removes the asset with the given id from the collection.

Parameters

id	IN the asset's LibraryAssetID

virtual void ILibraryAssetCollection::SetHasChangedStatus ( )

pure virtual

• For Internal Use Only *