IPreflightRuleData.h

//========================================================================================
// 
// $File$
// 
// Owner: SusanCL
// 
// $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 "IPMUnknown.h"
#include "PackageAndPreflightID.h"
#include <vector>

#include "ScriptData.h"

class IPreflightRuleData : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPREFLIGHTRULEDATA };

public:
 typedef PMString Key;
 typedef ScriptData::ScriptDataType ValueType;

 virtual Key AnInvalidKey () const = 0;

 //_______________________________________________________________________________
 // Read access
 //_______________________________________________________________________________

 virtual bool KeyExists(const Key& k) const = 0;

 virtual ValueType GetValueType(const Key& k) const = 0;
 virtual void GetData (const Key& k, const ScriptData& defData, ScriptData& data, bool* pExist = nil) const = 0;
 virtual void GetAllKeys (std::vector<Key>& keyList) const = 0;

 virtual Key GetKey () const = 0;

 //_______________________________________________________________________________
 // Write access
 //_______________________________________________________________________________

 virtual void SetData (const Key& k, const ScriptData& data) = 0;
 virtual void RemoveKey(const Key& k) = 0;
 virtual void RemoveAllKeys() = 0;

 virtual void CopyFrom(const IPreflightRuleData* iSrc) = 0;

 //_______________________________________________________________________________
 // Utility
 //_______________________________________________________________________________

 virtual bool IsEqual(const IPreflightRuleData* iOther) const = 0;
};