IPreflightRuleData Class Reference

#include <IPreflightRuleData.h>

Inheritance diagram for IPreflightRuleData:

Public Types
enum	{ kDefaultIID = IID_IPREFLIGHTRULEDATA }
typedef PMString	Key
typedef ScriptData::ScriptDataType	ValueType

Public Member Functions
virtual Key	AnInvalidKey () const =0
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
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
virtual bool	IsEqual (const IPreflightRuleData *iOther) const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

This is the primary parameter data interface for preflight rules. It's dictionary based so we don't have to deal with versioning so much. It uses ScriptData as its internal data representation for the rule parameter data.

See Also

PreflightRuleDataHelper

Member Function Documentation

virtual Key IPreflightRuleData::AnInvalidKey ( ) const

pure virtual

Returns an invalid key. (Not sure if we need this.)

virtual void IPreflightRuleData::CopyFrom ( const IPreflightRuleData *  iSrc )

pure virtual

Copy data from another IPreflightRuleData interface.

Parameters

iSrc	is the interface to copy from.

virtual void IPreflightRuleData::GetAllKeys ( std::vector< Key > &  keyList ) const

pure virtual

Returns a list of the keys currently accessible. Note that the order of the keys returns does not reflect the order of the keys maintained internally.

Parameters

keyList

is the list of keys to be returned.

virtual void IPreflightRuleData::GetData ( const Key &  k, const ScriptData &  defData, ScriptData &  data, bool *  pExist = nil  ) const

pure virtual

Retrieve the data associated with specified key.

Parameters

k	is the key. is the default data to return if key does not exist. is the data associated with the specified to be returned. if not nil, will return a boolean indicates whether or not the key and data pair exists.

See Also

ScriptData.h

virtual Key IPreflightRuleData::GetKey ( ) const

pure virtual

Returns a single key. If there are more than one entry, it returns the first available key. If the data store is empty, it returns AnInvalidKey ().

Returns

a single key.

virtual ValueType IPreflightRuleData::GetValueType ( const Key &  k ) const

pure virtual

The data type associated with the data for this key.

Parameters

k	is the key.

Returns

the data type. The data type is one of the types supported by ScriptData::ScriptDataType.

See Also

ScriptData.h

virtual bool IPreflightRuleData::IsEqual ( const IPreflightRuleData *  iOther ) const

pure virtual

Determines whether the dictionaries are the same.

Parameters

iOther

IN The other dictionary to compare against.

Returns

kTrue if they're equal; kFalse otherwise.

virtual bool IPreflightRuleData::KeyExists ( const Key &  k ) const

pure virtual

Returns whether the key exists.

Parameters

k	is the key.

Returns

True if it exists; false otherwise.

virtual void IPreflightRuleData::RemoveAllKeys ( )

pure virtual

Remove all data entries.

virtual void IPreflightRuleData::RemoveKey ( const Key &  k )

pure virtual

Remove the data entry associated with the specified key.

Parameters

k	is the specified key.

virtual void IPreflightRuleData::SetData ( const Key &  k, const ScriptData &  data  )

pure virtual

Sets data.

Parameters

key	is the specified key to be associated with the data. is the data to set.