ILinkResource.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 used to maintain and access a linked resource.
// 
//========================================================================================

#ifndef __ILinkResource__
#define __ILinkResource__

// ----- Includes -----
#include "IPMUnknown.h"
#include "LinksID.h"
#include "AppInfo.h"
#include <boost/function.hpp>
class ILinkResourceHandler;
class IPMStream;

class FileTypeInfo;
class IDTime;
class PMString;
class UIDList;
class URI;
class WideString;


class ILinkResource : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ILINKRESOURCE };

 typedef URI ResourceId;
 typedef WideString ResourceStamp;

 virtual ResourceId GetURI() const = 0;

 virtual ResourceId GetId() const = 0;

 virtual bool IsIdEquivalent(const ResourceId& id) const = 0;

 virtual LinkClientID GetClientID() const = 0;

 virtual WideString GetShortName(bool bUIName) const = 0;

 virtual WideString GetLongName(bool bUIName) const = 0;

 enum ResourceState {
 kAvailable = 0,
 kMissing,
 kPending,
 kUnknown,
 kInaccessible
 };
 
 virtual ResourceState GetState() const = 0;

 virtual void SetState(ResourceState state) = 0;

 enum ResourceStoreState {
 kNormal = 0,
 kCached,
 kEmbedded,
 kContained
 };
 
 virtual ResourceStoreState GetStoreState() const = 0;

 virtual void SetContainedInObject() = 0;

 virtual ResourceStamp GetStamp() const = 0;

 virtual void SetStamp(const ResourceStamp& stamp) = 0;

 virtual bool IsStampEquivalent(const ResourceStamp& stamp) const = 0;

 virtual IDTime GetModTime() const = 0;

 virtual void SetModTime(const IDTime& time) = 0;

 virtual uint64 GetSize() const = 0;

 virtual void SetSize(uint64 size) = 0;

 virtual FileTypeInfo GetDataType() const = 0;

 virtual PMString GetFormatType() const = 0;

 virtual void SetFormatType(const PMString& formatType) = 0;

 enum AccessMode {
 kRead = 0,
 kWrite,
 kReadWrite
 };

 virtual bool IsAccessSupported(AccessMode mode) const = 0;

 virtual bool CanQueryStream(AccessMode mode) const = 0;

 virtual IPMStream* QueryStream(AccessMode mode) const = 0;

 virtual bool CanCache() const = 0;

 virtual ErrorCode Cache() = 0;

 virtual ErrorCode Uncache() = 0;

 virtual bool CanEmbed() const = 0;

 virtual ErrorCode Embed() = 0;

 virtual ErrorCode EmbedFromStream(IPMStream* stream) = 0;

 virtual bool CanUnembed() const = 0;

 virtual ErrorCode Unembed() = 0;

 virtual bool CanCopyToFile() const = 0;

 virtual ErrorCode CopyToFile(IDFile& file) const = 0;

 virtual bool CanEdit() const = 0;

 virtual ErrorCode Edit(const AppInfo& appInfo, PMString* errorString) = 0;

 virtual bool CanReveal() const = 0;

 virtual ErrorCode Reveal() = 0;
 
 virtual bool CanRevealInBridge() const = 0;

 virtual ErrorCode RevealInBridge() = 0;

 virtual bool CanRevealInCloudLibraries() const = 0;
 
 virtual ErrorCode RevealInCloudLibraries() = 0;

 virtual ErrorCode CopyAttributes(const UIDRef& resourceRef) = 0;

 virtual bool IsFPO() const = 0; 
 
 virtual bool CanGetXMPPacketInfo() const = 0;
 
 virtual bool GetXMPPacketInfo(std::string& packet) const = 0;


 enum ResourceDownloadState {
 kNotStarted = 0,
 kInProgress,
 kComplete,
 kDownloadError
 };

 virtual ResourceDownloadState GetDownloadProgress(PMReal& progress) const = 0;

 virtual bool CanDownloadOriginal() const = 0;

 virtual ErrorCode DownloadOriginal() = 0;

 typedef boost::function<void(const ILinkResource::ResourceId& resourceId, const ILinkResource::ResourceDownloadState& resourceDownloadState)> DownloadCompletionFunction;

 virtual ErrorCode AsyncDownloadOriginal(ILinkResource::DownloadCompletionFunction completionFunction) = 0;

 virtual bool CanReplaceFPOWithOriginal() const = 0;

 virtual bool CanProvideFile() const = 0;

 virtual ErrorCode GetFile(IDFile& idFile) const = 0;
 
 virtual bool CanGetLinkInstance() const = 0;
 
 /*
 Get the underlying link instance.
 @param PMString [OUT] instance the underlying instance name
 @return kSuccess if the link instance can be obtained, else an error code.
 */
 virtual ErrorCode GetlinkInstance(PMString &instance) const = 0;

};

#endif // __ILinkResource__