CLinkObject.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:
// Pure virtual base class that all ILinkObject derived classes should inherit.
// 
//========================================================================================

#ifndef __CLinkObject__
#define __CLinkObject__

// ----- Includes -----
#include "CPMUnknown.h"
#include "ILinkObject.h"

#include "ILink.h"
#include "UIDList.h"

class IPMStream;


class CLinkObject : public CPMUnknown<ILinkObject>
{
public:
 typedef CPMUnknown<ILinkObject> inherited;
 typedef object_type data_type;

 CLinkObject(IPMUnknown* boss);
 virtual ~CLinkObject();

 virtual LinkClientID GetClientID() const { return fClientId; }

 virtual bool IsDirectLink() const { return true; }
 virtual IPMUnknown* QueryLinkedObject(const PMIID& interfaceId) const;

 virtual bool CanUpdate(const ILinkResource* iResource, UID linkUID, UIFlags uiFlags, ErrorCode& err) const { return true; }

 virtual ClassID GetImportProvider(const ILinkResource* iResource, UID linkUID) const { return kInvalidClass; }
 virtual ClassID GetExportProvider(const ILinkResource* iResource, UID linkUID) const { return kInvalidClass; }
 virtual ClassID GetResolveProvider(const ILinkResource* iResource, UID linkUID) const { return kInvalidClass; }

 virtual UIDList GetLinks() const { return fLinkRefs; }

 virtual void MarkLinksModified() const;
 virtual void ClearLinksModified() const;

 virtual void ReadWrite(IPMStream* s, ImplementationID prop);

protected:
 LinkClientID fClientId;

private:
 virtual void AddLinkRef(UID linkUID);
 virtual void RemoveLinkRef(UID linkUID);

 void SetLinksObjectModificationState(ILink::ObjectModificationState modState) const;

 UIDList fLinkRefs;
};

#endif // __CLinkObject__