Inheritance diagram for IScriptErrorUtils:

Public Types
enum	{ kDefaultIID = IID_ISCRIPTERRORUTILS }

Public Member Functions
virtual ErrorCode	SetMissingRequiredParameterErrorData (const IScriptRequestData *scriptRequestData, const ScriptID param) const =0

virtual ErrorCode	SetInvalidParameterErrorData (const IScriptRequestData *scriptRequestData, const ScriptID param, ErrorCode err=kInvalidParameterError) const =0

virtual ErrorCode	SetOutOfRangeErrorData (const IScriptRequestData *scriptRequestData, const ScriptID param, const ScriptData &value) const =0

virtual ErrorCode	SetReadOnlyPropertyErrorData (const IScriptRequestData *scriptRequestData, const ScriptID param) 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

Member Function Documentation

virtual ErrorCode IScriptErrorUtils::SetInvalidParameterErrorData	(	const IScriptRequestData *	scriptRequestData,
		const ScriptID	param,
		ErrorCode	err = `kInvalidParameterError`
	)		const

pure virtual

Prepare data required to return an invalid parameter error

Parameters

scriptRequestData	is the IScriptRequestData associated with the script request
param	is the id of the invalid parameter
err	is the desired error code

virtual ErrorCode IScriptErrorUtils::SetMissingRequiredParameterErrorData	(	const IScriptRequestData *	scriptRequestData,
		const ScriptID	param
	)		const

pure virtual

Prepare data required to return a required parameter missing error

Parameters

scriptRequestData	is the IScriptRequestData associated with the script request
param	is the id of the missing parameter

virtual ErrorCode IScriptErrorUtils::SetOutOfRangeErrorData	(	const IScriptRequestData *	scriptRequestData,
		const ScriptID	param,
		const ScriptData &	value
	)		const

pure virtual

Prepare data required to return an out of range error

Parameters

scriptRequestData	is the IScriptRequestData associated with the script request
param	is the id of the out of range parameter
value	is the value of the out of range parameter

virtual ErrorCode IScriptErrorUtils::SetReadOnlyPropertyErrorData	(	const IScriptRequestData *	scriptRequestData,
		const ScriptID	param
	)		const

pure virtual

Prepare data required to return a read-only property error

Parameters

scriptRequestData	is the IScriptRequestData associated with the script request
param	is the id of the read-only property

Public Types