ILinkManager.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 manage linked resources and links.
// 
//========================================================================================

#ifndef __ILinkManager__
#define __ILinkManager__

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

#include "ILink.h"
#include "ILinkResource.h"
#include "LinksID.h"
#include <vector>

class ILinkObject;

class LinkResourceQuery;
class LinkQuery;
class URI;
class WideString;


class ILinkManager : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ILINKMANAGER };

 class ChangeData
 {
 public:
 typedef object_type data_type;

 enum Type {
 kLink = 0,
 kResource,
 kLinksResource
 };

 ChangeData(Type type, UID uid) : fType(type), fUID(uid) {}
 ChangeData(const ChangeData& data) : fType(data.fType), fUID(data.fUID) {}
 ~ChangeData() {}

 ChangeData& operator=(const ChangeData& rhs)
 {
 ChangeData temp(rhs);
 std::swap(temp.fType, fType);
 std::swap(temp.fUID, fUID);
 return *this;
 }

 bool operator==(const ChangeData& rhs) const { return (fType == rhs.fType && fUID == rhs.fUID); }
 bool operator<(const ChangeData& rhs) const
 {
 if (fType < rhs.fType) return true;
 else if (fType == rhs.fType) return (fUID < rhs.fUID);
 else return false;
 }

 Type GetType() { return fType; }
 UID GetUID() { return fUID; }

 static ChangeData Make(Type type, UID uid) { return ChangeData(type, uid); }

 private:
 Type fType;
 UID fUID;
 };

 typedef std::vector<UID> QueryResult;

 enum OperationType {
 kAsynchronous = 0,
 kSynchronous
 };
 
 virtual bool IsModelChanging() const = 0;

 virtual UID CreateResource(const URI& uri, LinkClientID clientId, bool bUseExisting) = 0;

 virtual ErrorCode ReinitResource(UID resourceUID, const URI& uri, bool updateResourceStateSync = true) = 0;

 virtual ErrorCode DeleteResource(UID resourceUID) = 0;

 virtual ILinkResource* QueryResourceByUID(UID resourceUID) const = 0;

 virtual ErrorCode UpdateResourceState(UID resourceUID, OperationType opType) = 0;

 virtual void CancelUpdateResourceState(UID resourceUID) = 0;

 virtual void WaitForUpdateResourceStateCompletion(UID resourceUID) = 0;


 virtual ErrorCode ResolveResource(UID resourceUID, const URI& relativeURI, bool bIgnoreStamp) = 0;

 virtual uint32 QueryResources(const LinkResourceQuery& query, LinkClientID clientId, QueryResult& result) const = 0;
 uint32 QueryResources(const LinkResourceQuery& query, QueryResult& result) const
 { return QueryResources(query, kIDLinkClientID, result); }

 virtual uint32 QueryResources(const LinkResourceQuery& query, LinkClientID clientId, UIDList& result) const = 0;
 uint32 QueryResources(const LinkResourceQuery& query, UIDList& result) const
 { return QueryResources(query, kIDLinkClientID, result); }

 virtual ClassID GetResourceProviderByScheme(const WideString& scheme) const = 0;


 virtual UID CreateLink(ILink::LinkType type, LinkClientID clientId, UID resourceUID, UID objectUID) = 0;

 virtual UID CreateLink(ClassID classID, LinkClientID clientId, UID resourceUID, UID objectUID) = 0;

 virtual ErrorCode DeleteLink(UID linkUID, bool bDeleteResource) = 0;

 virtual ILink* QueryLinkByUID(UID linkUID) const = 0;

 virtual uint32 QueryLinks(const LinkQuery& query, LinkClientID clientId, QueryResult& result) const = 0;
 uint32 QueryLinks(const LinkQuery& query, QueryResult& result) const
 { return QueryLinks(query, kIDLinkClientID, result); }

 virtual uint32 QueryLinks(const LinkQuery& query, LinkClientID clientId, UIDList& result) const = 0;
 uint32 QueryLinks(const LinkQuery& query, UIDList& result) const
 { return QueryLinks(query, kIDLinkClientID, result); }

 virtual uint32 QueryLinksByResourceUID(UID resourceUID, bool bChildLinksOK, QueryResult& result) const = 0;
 virtual uint32 QueryLinksByResourceUID(UID resourceUID, bool bChildLinksOK, UIDList& result) const = 0;

 virtual uint32 QueryLinksByObjectUID(UID objectUID, QueryResult& result) const = 0;
 virtual uint32 QueryLinksByObjectUID(UID objectUID, UIDList& result) const = 0;


 virtual ILinkObject* QueryObjectByUID(UID objectUID) const = 0;
};

#endif // __ILinkManager__