ILinkResourceStateUpdater.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 that implements state update and location resolution
// for an ILinkResource that is specific to the type of the resource as identified by
// the scheme of the link resource's URI.
// 
//========================================================================================

#ifndef __ILinkResourceStateUpdater__
#define __ILinkResourceStateUpdater__

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

#include "AsyncWork.h"

class URI;


class ILinkResourceStateUpdater : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ILINKRESOURCESTATEUPDATER };

 virtual ErrorCode UpdateResourceStateSync(const UIDRef& resourceRef, bool bNotify) = 0;

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

 virtual void CancelUpdateResourceState(const UIDRef& resourceRef) = 0;

 virtual void WaitForUpdateResourceStateCompletion(const UIDRef& resourceRef) = 0;

 virtual ErrorCode ResolveResource(const UIDRef& resourceRef, const URI& relativeURI, bool bIgnoreStamp) = 0;

#ifdef UPDATELINKS_ASYNC 

 virtual bool16 DoesSupportUpdateResourceStateThroughAsyncWorkManager(const UIDRef& resourceRef) = 0;

 virtual ErrorCode UpdateResourceStateAsyncWithPacketID(const UIDRef& resourceRef, bool16 bCheckOutstandingPackets, AsyncWorkPacketID& packetID) = 0;

 virtual ErrorCode ResolveResourceAsync(const UIDRef& resourceRef, const URI& relativeURI, bool bIgnoreStamp, bool16* statusBoolPtr, bool16 bCheckOutstandingPackets, AsyncWorkPacketID& packetID) = 0;
#endif

};

#endif // __ILinkResourceStateUpdater__