ILinkUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Adrian O'Lenskie
// 
// $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 __ILinkUtils__
#define __ILinkUtils__

#include "LinksID.h"
#include "ILinkResource.h"
#include "URI.h"

class ILink;
class ICoreFilename;
class IDataLink;
class ILinkUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ILINKUTILS };

 virtual ErrorCode CopyLinks(IDataBase* iDataBase, UID sourceItemUID, UID targetItemUID) = 0;

 virtual ErrorCode ReplaceLinks(IDataBase* iDataBase, UID sourceItemUID, UID targetItemUID) = 0;

 virtual ErrorCode CopyLinkToLinkObject(const UIDRef& sourceLinkUIDRef, const UIDRef& targetObjectUIDRef, UID& newLink) = 0;

 virtual UID GetLink(const UIDRef& itemRef) const = 0;

 virtual UID FindLink(const UIDRef& itemRef) const = 0;

 virtual UID FindLinkResource(const UIDRef& itemRef) const = 0;

 virtual bool IsLinkMissing(const UIDRef& itemRef) const = 0;

 virtual bool IsLinkEmbedded(const UIDRef& itemRef) const = 0;

 virtual bool IsLinkMissingOrOutOfDate(const UIDRef& itemRef) const = 0;

 virtual bool IsResourceLinked(const UIDRef& resourceRef) const = 0;

 virtual bool GetFileFromLink(ILink *link, IDFile *file) const = 0;

 virtual bool GetFileFromLink(const UIDRef& itemRef, IDFile *file) const = 0;

 virtual IPMStream* CreateReadStreamFromLink(const UIDRef& itemRef) const = 0;

 virtual IPMStream* CreateWriteStreamFromLink(const UIDRef& itemRef) const = 0;

 virtual ErrorCode CreateFileFromEmbedded(const UIDRef& itemRef, IDFile& file) const = 0;

 virtual IPMStream* QueryLinkedStream(const UIDRef& itemRef) const = 0;

 virtual uint64 GetUIDSize(IDataBase *db, UID uid) const = 0;

 virtual bool IDFileToResourceId(const IDFile& file, ILinkResource::ResourceId& resourceId) const = 0;
 
 virtual bool CloudAssetRefToResourceId(const std::string& assetRef, ILinkResource::ResourceId & resourceId) const=0;
 
 virtual bool ResourceIdToIDFile(const ILinkResource::ResourceId& resourceId, IDFile& file) const = 0;
 
 virtual UID FindMatchingResource(const UIDRef& resourceRef, bool bEmbedded) const = 0;

 virtual UID FindMatchingResource(IDataBase* db, const LinkClientID& clientID, const ILinkResource::ResourceId& resourceId, bool bEmbedded) const = 0;

 virtual bool GetEditorList(const UIDRef& linkResource, AppInfoList& appList, const bool16 bDefaultEditorOnly) = 0;

 virtual bool ComposePath(IDFile& file) const = 0;

 virtual bool32 IsINDDInternalLink(const ILink* iLink) const = 0;

 virtual bool GetOPIName(const UIDRef& itemRef, PMString& name) const = 0;

 virtual bool16 GetXMPPacket(IDFile& theFile, std::string& packet) = 0;

 virtual WideString GetLinkScheme(const ILink* iLink) = 0;

 virtual bool16 IsLinkContentAvailable(const ILink* iLink) = 0;

};

#endif // __ILinkUtils__