SysObsoleteAttribute Class [AX 2012]

The SysObsoleteAttribute class marks a method, class, or table as obsolete.

Syntax

class SysObsoleteAttribute extends SysAttribute

Run On

Called

Methods

	Method	Description
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	Explanation	Retrieves the explanation associated with the obsolete attribute.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	isError	Indicates whether the compiler will display an error message or a warning.
	new	Initializes an instance of the SysObsoleteAttribute class. (Overrides the new Method.)
	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.)
	parmExplanation	Retrieves the explanation that is associated with the obsolete attribute.
	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.)
	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.)

Top

Remarks

The X++ language has syntax that enables you to mark other items with an attribute class. The other item types are classes, tables, and methods. The SysObsoleteAttribute class is special because it affects the X++ compiler. The X++ compiler issues either an error or warning when it encounters use of an item that is marked with the SysObsoleteAttribute class. The X++ compiler calls the SysObsoleteAttribute.isError method to determine whether the message must be issued as an error versus a warning. The compiler calls the SysObsoleteAttribute.Explanation method and displays the returned string to the user. This string explains the recommended alternative. The SysObsoleteAttribute class inherits from the SysAttribute class. The SysObsoleteAttribute class is implemented in the kernel.

Inheritance Hierarchy

Object Class
  SysAttribute Class
    SysObsoleteAttribute Class