AifFault Class [AX 2012]

The AifFault class provides a static programming model to throw fault messages.

Syntax

class AifFault extends SysInfoAction

Run On

Called

Methods

	Method	Description
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	description	(Inherited from SysInfoAction.)
	enabled	(Inherited from SysInfoAction.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	getCode	Microsoft internal use only.
	getContext	Microsoft internal use only.
	getDetailXml	Microsoft internal use only.
	getFaultType	Microsoft internal use only.
	getReason	Microsoft internal use only.
	getReasonLabelId	Microsoft internal use only.
	getReasonStringSubstitutionParameters	Microsoft internal use only.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	hasAccessRights	Indicates whether the user has access to this resource. (Inherited from SysInfoAction.)
	new	Microsoft internal use only.
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	pack	Microsoft internal use only. (Overrides the pack Method.)
	run	(Inherited from SysInfoAction.)
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	unpack	Deserializes the packedClass parameter value to an instance of the AifFault class. (Overrides the unpack Method.)
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::buildReason
	::checkFailedLogFault	Logs the fault as a warning.
	::fault	Throws a single fault that has the error message to the end user.
	::faultList	Throws a fault that has the error message and a list of all logged faults to the end user.
	::faultXml	Microsoft internal use only.
	::getExceptionFromInfologData	Microsoft internal use only.
	::getFaultFromInfologData	Microsoft internal use only.
	::getRootFault	Microsoft internal use only.
	::hasFault	Specifies whether any faults were logged.
	::logError	Logs the fault as an error.
	::logWarning	Logs the fault as a warning.
	::serialize	Microsoft internal use only.

Top

Remarks

The AifFault class throws the actual error message to the end user. Compare this to using the error and warning methods of the Infolog. In this case a generic message, "Request failed. See the exception log for more information", is displayed to the end user.

Do not use the AifFault class if the error message is to be hidden for security reasons.

Inheritance Hierarchy

Object Class
  SysInfoAction Class
    AifFault Class