IAMServiceProvider.h

//========================================================================================
// 
// $File$
// 
// Owner: Bill Tislar
// 
// $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.
// 
//========================================================================================

#ifndef __IAMSERVICEPROVIDER__
#define __IAMSERVICEPROVIDER__

#include "IPMUnknown.h"
#include "workgroupid.h"
#include "IDFile.h"
#include "FileTypeRegistry.h"
#include "ILinkResource.h"
#include "IOpenFileCmdData.h"
#include "IManageableAsset.h"

class IAMService;
class WideString;

class IAMServiceProvider : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IAMSERVICEPROVIDER };
 
 enum AssetService
 {
 enInvalidService = 0,
 
 enEnsureLatestVersion = kWorkgroupPrefix + 1,
 
 enCheckIn = kWorkgroupPrefix + 2,
 
 enRevert = kWorkgroupPrefix + 3,
 
 enCheckOut = kWorkgroupPrefix + 4,
 
 enCancelCheckOut = kWorkgroupPrefix + 5,
 
 enTerminate = kWorkgroupPrefix + 6,
 
 enInitialize = kWorkgroupPrefix + 7,
 
 enAfterSave = kWorkgroupPrefix + 8,
 
 enAfterSaveAs = kWorkgroupPrefix + 9,
 
 enUpdateStoredAssetReference = kWorkgroupPrefix + 10,
 
 enUpdateProxyVersionNumber = kWorkgroupPrefix + 11,
 
 enInvalidateProxyVersionNumber = kWorkgroupPrefix + 12,

 enGetUniqueAssetLocation = kWorkgroupPrefix + 13,
 
 enBatchCheckIn = kWorkgroupPrefix + 14,
 
 enAfterCheckIn = kWorkgroupPrefix + 15,
 
 enBeforeCheckOut = kWorkgroupPrefix + 16,
 
 enAfterCancelCheckOut = kWorkgroupPrefix + 17,
 
 enUpdateLinkLocation = kWorkgroupPrefix + 18,
 
 enRelink = kWorkgroupPrefix + 19,
 
 enUnembed = kWorkgroupPrefix + 20,

 enStoreCheckInData = kWorkgroupPrefix + 21,
 
 enRetrieveCheckInData = kWorkgroupPrefix + 22
 
 }; // end AssetService enum
 
 
 class AssetHints
 {
 public:
 AssetHints() :
 kFileType(0),
 kFileExtension(PMString(""))
 {}
 AssetHints( SysOSType sysOSType, PMString & fileExtension ) :
 kFileType(sysOSType),
 kFileExtension(fileExtension)
 {}
 AssetHints( const AssetHints & hints ) :
 kFileType(hints.kFileType),
 kFileExtension(hints.kFileExtension)
 {}
 AssetHints& operator = (const AssetHints &copy)
 { kFileType = copy.kFileType; kFileExtension = copy.kFileExtension; return *this; } 
 SysOSType kFileType;
 PMString kFileExtension;
 }; // end AssetHints


 virtual bool16 CanService( const IDFile & file, const IAMServiceProvider::AssetHints * hints = nil ) = 0;

 virtual bool16 CanService( const IManageableAsset * asset ) = 0;

 virtual bool16 CanUpdateScriptedAssetData( UIDRef assetRef, const PMString & scriptString, int32 scriptID ) = 0;
 
 virtual bool16 GetLinkResourceId( const IDFile & inFile, ILinkResource::ResourceId & outResourceId ) = 0;
 
 virtual IAMService* GetService( int32 assetServiceID ) = 0;

 virtual ErrorCode Init() = 0;
 
 virtual bool16 IsTemporaryVersion( const IDFile & file ) = 0;
 
 virtual bool16 IsVersioned( const IDFile & file ) = 0;
 
 virtual IOpenFileCmdData::OpenFlags OverrideOpenFlags( const IDFile & file, IOpenFileCmdData::OpenFlags inOpenFlags ) = 0;
 
 virtual ErrorCode UpdateScriptedAssetData( UIDRef assetRef, const PMString & scriptString, int32 scriptID ) = 0;
 
 virtual bool16 IsWriteable( const IDFile & assetFile ) = 0;
 
 virtual bool16 GetLockData( const IDFile & assetFile, IManagedStatus::StatusStringTable & outLockData, UIFlags uiFlags = kFullUI ) = 0;
 
}; // end IAMServiceProvider interface

#endif // __IAMSERVICEPROVIDER__