#include <IPreflightResultNodeData.h>

Inheritance diagram for IPreflightResultNodeData:

Public Types
enum	{ kDefaultIID = IID_IPREFLIGHTRESULTNODEDATA }

enum	InfoField { kFieldRequired, kFieldProblem, kFieldFix }

Public Member Functions
virtual void	SetObjectID (const PreflightObjectID &objID)=0

virtual const PreflightObjectID &	GetObjectID () const =0

virtual void	SetRootSortValue (const PreflightRuleID &ruleID)=0

virtual void	SetRootSortValue (const PMString &s)=0

virtual void	SetName (const PMString &name)=0

virtual PMString	GetName () const =0

virtual PMString	GetSortValue () const =0

virtual WideString	GetUniqueString () const =0

virtual void	AddInfoString (InfoField whichField, const PMString &s)=0

virtual void	AddInfoString (const PMString &fieldLabel, const PMString &s)=0

virtual PMString	GetInfoText () const =0

virtual void	GetDescriptionPairs (IPreflightResultNodeInfo::DescriptionPairVector &pairs) const =0

virtual IPreflightResultNodeInfo::NodeType	GetNodeType () const =0

virtual void	SetNodeType (IPreflightResultNodeInfo::NodeType t)=0

virtual PMString	GetPageNumber () const =0

virtual void	SetPageNumber (const PMString &sPage)=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 interface "lives" on the result node created by IPreflightAggregatedResultsUtils. It serves as the data for the IPreflightResultNodeInfo, which is the generic accessor used by the rest of the preflight UI. So this is an implementation-dependent interface that isn't required/guaranteed on other IPreflightResultNodeInfo implementations.

The purpose of this interface is to allow for reasonable setup of a result node because they tend to carry a lot of data/strings that are painful to construct and pass in one step.

This interface lives on the kPreflightResultNodeBoss which exists only in memory.

Member Function Documentation

virtual void IPreflightResultNodeData::AddInfoString	(	InfoField	whichField,
		const PMString &	s
	)

pure virtual

Appends an info string.

Parameters

whichField	IN The prefix to put before the string. If kFieldCustom no prefix is added.
s	IN The string to add.

virtual void IPreflightResultNodeData::AddInfoString	(	const PMString &	fieldLabel,
		const PMString &	s
	)

pure virtual

Appends an info string with a custom field name.

Parameters

label	IN The label for the field. Do not include a colon, just the string.
s	IN The string to add.

virtual void IPreflightResultNodeData::GetDescriptionPairs ( IPreflightResultNodeInfo::DescriptionPairVector & pairs ) const

pure virtual

Gets the strings as a vector.

Parameters

pairs OUT Receives a vector of description pairs

virtual PMString IPreflightResultNodeData::GetInfoText ( ) const

pure virtual

Gets the single string representing the concatenated info string.

virtual PMString IPreflightResultNodeData::GetName ( ) const

pure virtual

Returns: the name, ie the string that appears in the tree view itself.

virtual IPreflightResultNodeInfo::NodeType IPreflightResultNodeData::GetNodeType ( ) const

pure virtual

Get the node type that is reported via IPreflightResultNodeInfo.

Returns: the node type.

virtual const PreflightObjectID& IPreflightResultNodeData::GetObjectID ( ) const

pure virtual

Gets the object.

virtual PMString IPreflightResultNodeData::GetPageNumber ( ) const

pure virtual

Get the page number that is reported via IPreflightResultNodeInfo.

Returns: the page number, or empty string if there is none.

virtual PMString IPreflightResultNodeData::GetSortValue ( ) const

pure virtual

Get the sorting string. This determines the sort order compared to others at the same hierarchy level.

Returns: A string that is used for sorting purposes.

virtual WideString IPreflightResultNodeData::GetUniqueString ( ) const

pure virtual

Get a unique string – a hash, basically – which uniquely identifies the node apart from all others in a given results set. Typically this is built using the rule ID, object ID hash, etc. This is used to support mapping of results between invalidations in the UI since the IPreflightResultNode::NodeID can vary.

Returns: A unique identifier string.

virtual void IPreflightResultNodeData::SetName ( const PMString & name )

pure virtual

Sets the name, ie the string that appears in the tree view itself.

virtual void IPreflightResultNodeData::SetNodeType ( IPreflightResultNodeInfo::NodeType t )

pure virtual

Set the node type reported via IPreflightResultNodeInfo.

Parameters

t	IN The new node type.

virtual void IPreflightResultNodeData::SetObjectID ( const PreflightObjectID & objID )

pure virtual

Sets the object.

virtual void IPreflightResultNodeData::SetPageNumber ( const PMString & sPage )

pure virtual

Set the page number reported via IPreflightResultNodeInfo.

Parameters

sPage IN The new page number string.

virtual void IPreflightResultNodeData::SetRootSortValue ( const PreflightRuleID & ruleID )

pure virtual

Sets the root sorting value automatically based on the rule.

virtual void IPreflightResultNodeData::SetRootSortValue ( const PMString & s )

pure virtual

Sets the root sorting value. This is used to control the sorting of nodes in the trees. For nodes with object IDs this isn't required unless you want to force results above or below the natural sorting ranges.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation