Local ABAP exception classes (inside global classes)

[LaurensDeprost]

• Why use local exception classes?


• Class editor: source-code based or ADT ⚠️


• Defining a local exception class
  
  
  
  • Source-code based Class Builder
  
  
  • Eclipse with ADT
  
  
  
  


• Example


• Further reading


• Conclusion

 

Why use local exception classes?

Although it is generally best practice to create global exception classes, they can seem a bit overkill for some applications. Think of PoCs, demo scenarios, BAdI implementations, etc. A handy but not so well-known option for these situations is to define a local exception class inside the global class. These allow internal exceptions (exceptions raised within the class itself) to be handled without the need for another global DDIC object. The SAP Help Portal describes local classes as follows:

Local definitions, especially local classes, can be useful as auxiliary classes for the global class. In local classes you can encapsulate implementation details that should not be visible from the outside (they should not even occur in the private section).

Class editor: source-code based or ADT ⚠️

Before you get coding, take into consideration that local exception classes do not play well with the classical Form-Based Class Builder. Use the Source Code-Based editor or Eclipse with ADT instead.

 

Defining a local exception class

 

Source-code based Class Builder

To add a local exception class definition within a global class first open the global class in SE24 or SE80. Next, open the menu path Goto → Local Definitions/Implementations → Local Definitions/Implementations.

 

Alternatively, you can click the toolbar button labeled ‘Local Definitions/Implementations’. You can now enter the logic for the local exception class.

 

Eclipse with ADT

To add or edit a local class definition in the ABAP Development Tools in Eclipse, first open the global class. Do this via double-clicking the corresponding entry in the Project Explorer or via the ‘Open ABAP Development Object’ tool. Open the latter via its menu option Navigate → Open ABAP Development Object or its corresponding keyboard shortcut Ctrl + Shift + A.

 

After opening the global class, define the local exception class in the tab ‘Class-relevant Local Types’. Next, open its local types section by clicking the tab labeled ‘Local Types’. You can now enter the definition and logic.

As noted by matthew.billingham in the comment section, usually, it's fine to just have the local class definition in the ‘Local Types’ tab. However, this can cause problems in some cases. Prevent potential issues by declaring the class separately using ‘DEFINITION DEFERRED’ in the ‘Class-relevant Local Types’ tab.

 

Example

The example below showcases a basic exception class for handling exceptions in an ALV reporting class.

*"* use this source file for the definition and implementation of

*"* local helper classes, interface definitions and type

*"* declarations

CLASS lcx_ca_gen_report DEFINITION INHERITING FROM cx_dynamic_check.

  PUBLIC SECTION.

    INTERFACES if_t100_dyn_msg.

    ALIASES msgty FOR if_t100_dyn_msg~msgty.

ENDCLASS.

 

 

We can now use this exception class in the internal methods of the global class.

"Program error in ALV-based output list, contact support

RAISE EXCEPTION TYPE lcx_ca_gen_report

    MESSAGE e014(j_3rvatd).

 

Further reading

• Creating Local Definitions and Implementations, SAP Help Portal


• Classes & scope, Clean ABAP


• Error handling, Clean ABAP


• Local exception class in global class – the trick, SAP Community Blog

Conclusion

Local exception classes can provide distinct exceptions to internal class methods without creating a new global exception class. However, do they have added value in a particular situation? What is your opinion? Do you consider them a useful option for specific cases or a bad habit for lazy developers? Good practice or bad practice?
Share your feedback in the comments 👇