IPreflightExpansionHelper.h

//========================================================================================
// 
// $File$
// 
// Owner: Matt Phillips
// 
// $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.
// 
//========================================================================================


class IPreflightOptions;
class IPreflightProcess;
class IPreflightObjectModelService;

class IPreflightExpansionHelper
{
public:
 IPreflightExpansionHelper() {}

 virtual ~IPreflightExpansionHelper() {}

 virtual IPreflightProcess* QueryProcess() const = 0;

 virtual const IPreflightOptions* QueryPreflightOptions() const = 0;

 enum
 { 
 kAddedChildToDatabase = (1L<<1), 

 kChildNotRequired = (1L<<2),

 kChildTBDLinkRemoved = (1L<<3),

 kNewLinkAdded = (1L<<4),

 kDuplicateLink = (1L<<5),

 kNoChangeBecauseParentNotFound = (1L<<6),

 kAddedChildToExpansionList = (1L<<8),

 kAddedChildToVisitList = (1L<<9),

 kInternalError = (1L<<30)

 };
 
 typedef uint32 AddResult; // A combination of the above flags

 virtual const PreflightObjectID& GetParentObjectID() const = 0;

 virtual IPreflightObject* GetParentObject() const = 0;

 virtual IDataBase* GetDataBase() const = 0;

 virtual bool ShouldAdd(PreflightObjectClassID childClassID) const = 0;
 
 virtual bool ExistsInDatabase(const PreflightObjectID& objID) const = 0;
 
 virtual AddResult AddChild
 (
 const PreflightObjectID& childID, 
 bool asReference = kFalse
 ) = 0;

 virtual AddResult AddObjectWithTBDParent
 (
 const PreflightObjectID& childID
 ) = 0;

 virtual void ExpandAgainLater(const IPreflightObjectModelService* iService, uint32 timeDelay_ms = 0) = 0;
};