ILinkResourceHandler.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Easter
// 
// $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.
// 
// 
// Description:
// This class defines an interface that implements behavior for an ILinkResource that
// is specific to the type of the resource as identified by the scheme of the link
// resource's URI.
// 
//========================================================================================

#ifndef __ILinkResourceHandler__
#define __ILinkResourceHandler__

// ----- Includes -----
#include "IPMUnknown.h"
#include "LinksID.h"
#include "AppInfo.h"

#include "ILinkResource.h"


class ILinkResourceHandler : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ILINKRESOURCEHANDLER };

 virtual bool Init(const UIDRef& ref, const URI& uri) = 0;

 virtual bool IsResourceURIValid(const UIDRef& ref, const URI& uri) const = 0;

 virtual bool AreResourceIdsEquivalent(const ILinkResource::ResourceId& id1, const ILinkResource::ResourceId& id2) const = 0;

 virtual FileTypeInfo GetResourceDataType(const UIDRef& ref, const URI& uri) const = 0;

 virtual WideString GetShortResourceName(const UIDRef& ref, const URI& uri, bool bUIName) const = 0;

 virtual WideString GetLongResourceName(const UIDRef& ref, const URI& uri, bool bUIName) const = 0;

 virtual PMString GetResourceStateInfo(const UIDRef& ref, const URI& uri, ILinkResource::ResourceState state, ILinkResource::ResourceStoreState storeState) const = 0;

 virtual bool AreStampsEquivalent(const WideString& stamp1, const WideString& stamp2) const = 0;

 virtual bool CanReadResource(const UIDRef& ref, const URI& uri) const = 0;

 virtual bool CanWriteResource(const UIDRef& ref, const URI& uri) const = 0;

 virtual bool CanReadWriteResource(const UIDRef& ref, const URI& uri) const = 0;

 virtual bool CanCreateResourceStream(const UIDRef& ref, const URI& uri, ILinkResource::AccessMode access) const = 0;

 virtual IPMStream* CreateResourceReadStream(const UIDRef& ref, const URI& uri) const = 0;

 virtual IPMStream* CreateResourceWriteStream(const UIDRef& ref, const URI& uri) const = 0;

 virtual IPMStream* CreateResourceReadWriteStream(const UIDRef& ref, const URI& uri) const = 0;

 virtual bool CanCacheResource(const UIDRef& ref, const URI& uri) const = 0;

 virtual bool CanEmbedResource(const UIDRef& ref, const URI& uri) const = 0;

 virtual bool CanUnembedResource(const UIDRef& ref, const URI& uri) const = 0;

 virtual bool CanCopyToFile(const UIDRef& ref, const URI& uri) const = 0;

 virtual ErrorCode CopyToFile(const UIDRef& ref, const URI& uri, IDFile& file) const = 0;

 virtual bool CanEditResource(const UIDRef& ref, const URI& uri) const = 0;

 virtual ErrorCode EditResource(const UIDRef& ref, const URI& uri, const AppInfo& appInfo, PMString* errorString) const = 0;

 virtual bool CanRevealResource(const UIDRef& ref, const URI& uri) const = 0;

 virtual ErrorCode RevealResource(const UIDRef& ref, const URI& uri) const = 0;

 virtual bool CanRevealResourceInBridge(const UIDRef& ref, const URI& uri) const = 0;

 virtual ErrorCode RevealResourceInBridge(const UIDRef& ref, const URI& uri) const = 0;
 
 virtual bool CanRevealResourceInCloudLibraries(const UIDRef& ref, const URI& uri) const = 0;
 
 virtual ErrorCode RevealResourceInCloudLibraries(const UIDRef& ref, const URI& uri) const = 0;

 virtual bool CanGetXMPPacketInfo(const UIDRef& ref, const URI& uri) const = 0;

 virtual bool GetXMPPacketInfo(const UIDRef& resourceRef, const URI& uri, std::string& packet) const = 0;

 virtual bool CanDownloadOriginalResource(const UIDRef& ref, const URI& uri) const = 0;

 virtual ErrorCode DownloadOriginalResource(const UIDRef& ref, const URI& uri) const = 0;

 virtual ErrorCode AsyncDownloadOriginalResource(const UIDRef& ref, const URI& uri, ILinkResource::DownloadCompletionFunction completionFunction) const = 0;

 virtual bool CanReplaceFPOWithOriginalResource(const UIDRef& ref, const URI& uri) const = 0;

 virtual ILinkResource::ResourceDownloadState GetResourceDownloadProgress(const UIDRef& ref, const URI& uri, PMReal& progress) const = 0;

 virtual bool CanProvideFile(const UIDRef& ref, const URI& uri) const = 0;

 virtual ErrorCode GetFile(const UIDRef& ref, const URI& uri, IDFile& idFile) const = 0;
 
 /*
 Determines if a resource can get the underlying instance name or not.
 @return true if the resource can provide the underlying instance name.
 */
 virtual bool canGetInstanceName() const = 0;
 
 /*
 Get the underlying instance name from the link resource.
 @param instanceURI [OUT] authority component of the instance.
 return kSucess if it the instance name is available, else an error code.
 */
 virtual ErrorCode GetInstanceName(PMString &instanceURI) const = 0;
 
};

#endif // __ILinkResourceHandler__