ILink.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 establish a relationship between an
// ILinkObject and an ILinkResource.
// 
//========================================================================================

#ifndef __ILink__
#define __ILink__

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

class IPMStream;
class IDTime;
class UIDList;


class ILink : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ILINK };
 
 enum LinkType {
 kImport = 0,
 kExport,
 kBidirectional,
 kChild
 };

 virtual LinkType GetLinkType() const = 0;

 virtual LinkClientID GetClientID() const = 0;

 virtual UID GetResource() const = 0;

 virtual void SetResource(UID resourceUID) = 0;

 enum ResourceModificationState {
 kResourceModified = 0,
 kResourceUnmodified
 };
 
 virtual ResourceModificationState GetResourceModificationState() const = 0;

 virtual void SetResourceModificationState(ResourceModificationState modState) = 0;

 virtual UID GetObject() const = 0;

 virtual void SetObject(UID objectUID) = 0;

 enum ObjectModificationState {
 kObjectModified = 0,
 kObjectUnmodified
 };
 
 virtual ObjectModificationState GetObjectModificationState() const = 0;

 virtual void SetObjectModificationState(ObjectModificationState modState) = 0;

 virtual bool16 GetShowInUI() const = 0;

 virtual void SetShowInUI(bool16 bShowInUI) = 0;

 virtual bool16 GetCanEmbed() const = 0;

 virtual void SetCanEmbed(bool16 bCanEmbed) = 0;

 virtual bool16 GetCanUnembed() const = 0;

 virtual void SetCanUnembed(bool16 bCanUnembed) = 0;

 virtual bool16 GetCanPackage() const = 0;

 virtual void SetCanPackage(bool16 bCanPackage) = 0;

 enum ImportPolicy {
 kNoAutoImport = 0,
 kImportOnModify
 };
 
 virtual ImportPolicy GetImportPolicy() const = 0;

 virtual void SetImportPolicy(ImportPolicy policy) = 0;

 virtual WideString GetImportStamp() const = 0;

 virtual IDTime GetImportModTime() const = 0;

 virtual IDTime GetLastImportTime() const = 0;

 enum ExportPolicy {
 kNoAutoExport = 0,
 kExportOnModify,
 kExportOnClose,
 kExportOnSave
 };
 
 virtual ExportPolicy GetExportPolicy() const = 0;

 virtual void SetExportPolicy(ExportPolicy policy) = 0;

 virtual IDTime GetLastExportTime() const = 0;

 virtual void AddChildren(const UIDList& children) = 0;

 virtual void DeleteChildren(const UIDList& children) = 0;

 virtual uint32 GetChildren(UIDList& children) const = 0;

 virtual uint32 GetNumChildren() const = 0;

 virtual UID GetParent() const = 0;

 virtual ErrorCode Update(bool bForceUpdate, UIFlags uiFlags, UID& linkUID) = 0;

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

private:
 friend class LinkManager;
 friend class ScrapLinkManager;

 virtual bool Init(LinkClientID clientId, UID resourceUID, UID objectUID) = 0;

 friend class LinkScriptProvider;
 virtual void InitFromINX(IDataBase* db,
 LinkType type,
 LinkClientID clientId,
 const WideString& importStamp,
 const IDTime& importModTime,
 const IDTime& lastImportTime,
 const IDTime& lastExportTime,
 bool16 isSharedContentLink = kFalse) = 0;

 virtual ErrorCode CopyAttributes(const ILink* pLink) = 0;
};

#endif // __ILink__