Interface naming conventions
- Last Updated: January 17, 2024
- 1 minute read
- OpenEdge
- Version 12.8
- Documentation
Interface naming conventions
The API uses a standard naming convention for public interface names:
Syntax
|
Where ClassName is the name of the implementing class
for the interface. For entity objects, ClassName is the
entity name. For example, the IArea interface is implemented
by the Area class (for area objects) and the IAreaSet interface
is implemented by the AreaSet class (for area collection
objects). In the case of a few public super interfaces, which are
implemented by several classes, ClassName is
a more general name for the group of implementing classes and is
appended with Element (for entity classes) or Collection (for
entity collection classes). For example, IDataAdminElement is
implemented by all entity classes and IDataAdminCollection is
implemented by all entity collection classes. In addition, the API
supports multiple kinds of entity collections, depending on the
entity, and collection interfaces have a more detailed naming convention
based on the kind of collection. For more information, see Collection interface naming conventions.