AfEnumDescriptors Class [AX 2012]
The AfEnumDescriptors class provides access to enumeration metadata.
| 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.) |
| getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
| handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
| new | Initializes a new instance of the AfEnumDescriptors class. |
| 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.) |
| 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.) |
| ::addEnumNameIdPair | Adds an enumeration name and ID pair, which is defined by the _enumId parameter, to the enumeration map. |
| ::cacheEnumMap | Caches the enumeration map. |
| ::createEnumMap | Creates the enumeration map. |
| ::flushCache | Removes the data container metadata cache. |
| ::getCachedEnumMap | Retrieves the cached enumeration map. |
| ::getEnumDescriptor | Gets a descriptor for the enumeration that is identified by the specified ID. |
| ::getEnumId | Gets the ID for the enumeration that is identified by the specified name. |
| ::getEnumIds | Encodes the set of supported enumerations. |
| ::getEnumIdSet | Gets the set of the IDs of the supported enumerations. |
| ::getEnumMap | Gets the enumeration map. |
| ::getEnumName | Gets the name for the enumeration that is identified by the specified ID. |
| ::getEnumNameSet | Gets the set of the supported enumeration names. |
All the methods of this class are static and the class cannot be initialized.
Enumeration metadata is provided in the form of SysDictEnum objects. The set of supported enumerations is encoded in the AfEnumDescriptors.getEnumIds method. To add a new supported enumeration, update the AfEnumDescriptors.getEnumIds method.
At run time, the set of supported enumerations is stored as a map object that maps enumeration names to their IDs. The map is built the first time that it is requested and cached. Subsequent requests use the cached map.
Community Additions
ADD
Show: