Best Practices for Interfaces

Applies To: Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012

This topic provides information on the best practices for interfaces. Details are provided on interface names and interfaces that are provided by the Microsoft Dynamics AX development environment.

Interface Naming

The names of interfaces should follow the general naming guideline for classes.

It is a best practice to infix an interface name with the letter I to indicate that the type is an interface. The letter I should be infixed right after the prefix.

The following list provides examples of recommended interface names:

• SysIComponent (descriptive noun)

• CustITransactionProvider (noun phrase)

• CustIInvoicePersistable (adjective)

SysPackable

Classes that implement SysPackable must not pack the element IDs, such as Class, Field, or Table ID.

Classes that implement SysPackable must pack the same contents across versions (the same variables and the same types of variables). Another option is to change the version number of the container.

The following code example changes the version number of the container.

#define.CurrentVersion(2)

Note

Use a number other than 1.

SysUnitTestable

Classes that implement SysUnitTestable must have a name postfixed with 'UnitTest'.

See also

Interfaces Overview

Announcements: New book: "Inside Microsoft Dynamics AX 2012 R3" now available. Get your copy at the MS Press Store.