IPreflightProcess.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.
// 
//========================================================================================


#include "IPreflightObject.h"
#include "IPMUnknown.h"
#include "IPreflightProfile.h"
#include "IPreflightRuleInfo.h"
#include "PackageAndPreflightID.h"

class IdleTimer; // See IIdleTask.h
class IDocument;
class IPreflightAggregatedResults;
class IPreflightOptions;
class IPreflightSettingsChangeInfo;
class IPreflightResultRecordTable;

class IPreflightProcess : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPREFLIGHTPROCESS };

 enum OperatingState
 {
 kNothingToDo, 
 kInitializing,
 kWaitingForComposition,
 kExpandingTree,
 kVisitingTree,
 kResultsComplete
 };

 enum PauseState
 {
 kRunning = 0,

 kDocumentClosed,

 kUserPaused
 };

 enum PriorityType
 {
 kInactive,

 kLowPriority,

 kHighPriority
 };

public:

 virtual uint32 GetUniqueID() const = 0;

 virtual void SetUniqueID(uint32 id) = 0;

 virtual uint32 GetTimeStamp() const = 0;

 virtual ClassID GetSelector() const = 0;

 virtual void SetSelector(ClassID selID) = 0;

 virtual PreflightDocumentID GetDocumentID() const = 0;

 virtual void SetDocumentID(const PreflightDocumentID& newDocID) = 0;

 virtual void SetIsBookProcess(bool newState) = 0;

 virtual bool IsBookProcess() const = 0;

 virtual bool GetAutoDelete() const = 0;

 virtual void SetAutoDelete(bool newState) = 0;

 virtual void Clear() = 0;

 virtual void SetOptions(const IPreflightOptions* iOptions) = 0;

 virtual const IPreflightOptions* QueryOptions() const = 0;

 virtual const IPreflightProfile* QueryProfile() const = 0;

 virtual void SetProfile(IPreflightProfile* iProfile) = 0;


 virtual OperatingState GetState() const = 0;

 virtual PauseState GetPaused() const = 0;

 virtual void SetPaused(PauseState newState) = 0;

 virtual bool IsActive() const = 0;

 virtual PriorityType GetPriority() const = 0;
 
 virtual void AdvanceState(IdleTimer* timer, bool synchronous) = 0;

 virtual IPreflightAggregatedResults* CreateAggregatedResults() const = 0;

 typedef uint32 NodeID;

 typedef K2Vector<NodeID> NodeIDVector;

 typedef uint32 LinkID;

 typedef enum
 {
 kInvalidNodeType,
 kRoot,
 kObject,
 kResult,
 kDirectory
 } NodeType;

 typedef enum
 {
 kInvalidLinkType,
 kOwnership,
 kReference,
 kTemporary
 } LinkType;

 virtual NodeID GetRootNode() const = 0;

 virtual NodeID GetRootObjectNode() const = 0;

 virtual NodeType GetNodeType(NodeID node) const = 0;

 virtual LinkType GetLinkType(LinkID link) const = 0;

 virtual void GetParentNodes(NodeID node, NodeIDVector& parents) const = 0;

 virtual void GetChildNodes(NodeID node, NodeIDVector& children) const = 0;

 virtual LinkID GetFirstParentLink(NodeID node) const = 0;

 virtual LinkID GetNextParentLink(LinkID link) const = 0;

 virtual LinkID GetFirstChildLink(NodeID node) const = 0;

 virtual LinkID GetNextChildLink(LinkID link) const = 0;

 virtual NodeID GetLinkParentNode(LinkID link) const = 0;

 virtual NodeID GetLinkChildNode(LinkID link) const = 0;

 virtual void GetObjectNodeObjectID(NodeID node, PreflightObjectID& objID) const = 0;

 virtual void GetResultNodes(NodeIDVector& results) const = 0;

 virtual PreflightRuleID GetResultNodeRuleID(NodeID resultNode) const = 0;

 virtual IPreflightResultRecordTable* QueryResultNodeTable(NodeID resultNode) const = 0;


 virtual void InvalidateObject(const PreflightObjectID& objID) = 0;

 virtual void InvalidateDocument() = 0;

 virtual void OnSettingsChange(const IPreflightSettingsChangeInfo* iInfo) = 0;


 virtual PMString GetDescription() const = 0;

 virtual PMString GetResults() const = 0;

 virtual PMString GetInventory() const = 0;
};