ISharedContentFacade.h

//======================================================================================== 
// 
// $File$ 
// 
// Owner: Ashish Duggal
// 
// $Author$ 
// 
// $DateTime$ 
// 
// $Revision$ 
// 
// $Change$ 
//
// ADOBE CONFIDENTIAL
// 
// Copyright 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: 
// A high level API for dealing with shared content links, link resources and link objects.
// 
//======================================================================================== 

#ifndef __ISharedContentFacade__ 
#define __ISharedContentFacade__ 

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

#include "SharedContentID.h"
#include "Utils.h"
#include "URI.h"

// -----Forward Declarations------
class ILink;
class ILinkResource;
class ITextModel;


namespace Facade 
{ 

 class ISharedContentFacade : public IPMUnknown
 { 
 public: 
 enum { kDefaultIID = IID_ISHAREDCONTENTFACADE }; 

 enum LinkPageItemOption{ kPIUpdateOnSave,
 kPIWarnOnUpdateOfEditedPageItem,
 kPIStyleMappingExceptions,
 kPIPathgeometryOverride,
 kPIGraphicAttributesOverride,
 kPIInteractiveAttributesOverride,
 kPIContentOverride, 
 kPIOtherAttributesOverride}; 

 enum LinkStoryOption{ kUpdateOnSave,
 kWarnOnUpdateOfEditedStory,
 kRemoveForcedLineBreaks,
 kMapStyles, };

 virtual ErrorCode CreateSharedContentLink (const UIDRef& sourceRef, const UIDRef& targetRef, UID& outLinkUID) const = 0;

 virtual bool16 CanCreateSharedContentLink (const UIDRef& sourceRef, const UIDRef& targetRef) const = 0;

 virtual UIDRef GetLinkForSharedContentLinkObject(const UIDRef& linkObj) const = 0;
 
 virtual UIDRef GetResourceObjectForSharedContentLink(const UIDRef& linkResourceRef,const URI& linkedContentURI) const = 0;
 
 virtual bool16 IsSharedContentLink(const ILink* link) const = 0;

 virtual bool16 IsSharedContentInternalLink(const ILink* link) const = 0;

 virtual bool16 IsSharedContentExternalLink(const ILink* link) const = 0;

 virtual bool16 IsSharedContentLinkResource(const ILinkResource* linkResource) const = 0;

 virtual bool16 IsSharedContentExternalLinkResource(const ILinkResource* linkResource) const = 0;

 virtual bool16 IsSharedStoryLinkObject(const UIDRef& textModelRef) const = 0;

 virtual bool16 IsSharedPageItemLinkObject(const UIDRef& pageItemRef) const = 0;

 virtual bool16 IsSharedPageItemLink(const ILink* link) const = 0;

 virtual bool16 IsSharedStoryLink(const ILink* link) const = 0;

 virtual bool16 IsSharedPageItemLinkResource(const ILinkResource* linkResource) const = 0;

 virtual bool16 IsSharedStoryLinkResource(const ILinkResource* linkResource) const = 0;
 
 virtual bool16 IsSharedPageItemOptionSet(ILink* link, LinkPageItemOption option) const = 0;

 virtual bool16 IsSharedStoryOptionSet(ILink* link, LinkStoryOption option) = 0;
 
 virtual bool16 IsSharedStoryOptionSet(const UIDRef& textModel, LinkStoryOption option) = 0;

 virtual ErrorCode CopySharedPageItemOptions(const UIDRef& sourceRef, const UIDRef& targetRef) = 0;

 virtual ErrorCode CopySharedStoryOptions(const UIDRef& sourceModel, const UIDRef& targetModel) = 0;
 
 virtual ErrorCode SetSharedStoryOption(const UIDRef& textModel, LinkStoryOption option, const bool16 newValue) = 0;

 virtual ErrorCode SetSharedPageItemOption(const UIDRef& pageItem, LinkPageItemOption option, const bool16 newValue) = 0;
 
 virtual UIDRef GetResourceObjectForSharedStoryLink(const UIDRef& linkRef) const = 0;

 virtual bool16 ContainsSharedStoryLink(const UIDList& linkList) const = 0; 
 }; 

} // namespace Facade


#endif // __ISharedContentFacade__