| Addition | Notes | +
| + +`PUBLIC` + + | + ++ +Creates a global class + + | +
| + +`FINAL` + + | + ++ +The class does not allow inheritance. + + | +
| + +`CREATE PUBLIC` + + | + ++ +The class is instantiable anywhere. + + | +
| + +`CREATE PROTECTED` + + | + ++ +The class can only be instantiated in methods of its [subclasses](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/index.htm?file=abensubclass_glosry.htm "Glossary Entry"), of the class itself, and of its [friends](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/index.htm?file=abenfriend_glosry.htm "Glossary Entry"). + + | +
| + +`CREATE PRIVATE` + + | + ++ +The class can only be instantiated in methods of the class itself or of its friends. Hence, it cannot be instantiated as an inherited component of subclasses. + + | +
| + +`INHERITING FROM superclass` + + | + ++ +As the name implies, it is used to inherit from a visible [superclass](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/index.htm?file=abensuperclass_glosry.htm). If the addition is not specified, the created class implicitly inherits from the predefined empty, abstract class `object` (the root object). + + | +
| + +`ABSTRACT` + + | + ++ +To define [abstract](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/index.htm?file=abenabstract_glosry.htm) classes. These classes cannot be instantiated. These classes can contain both abstract methods and non-abstract methods. Abstract methods can only be implemented in [subclasses](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/index.htm?file=abensubclass_glosry.htm) by redefinition. See a simple implementation example [here](#excursion-example-interface). + + | +
| + +`[GLOBAL|LOCAL] FRIENDS class` + + | + ++ +- Used to define [friendships](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/index.htm?file=abenfriend_glosry.htm) (also possible for interfaces). Friends of a class have unrestricted access to all components of that class. +- `GLOBAL FRIENDS`: Used in global classes (together with the `PUBLIC` addition) to grant friendship to other global classes and interfaces +- `FRIENDS`: For local classes, e.g. local classes granting friendship to other local classes or the global class of the class pool +- `LOCAL FRIENDS`: Used for global classes to grant friendship to local classes and interfaces in its own class pool. However, it is a dedicated statement, as shown in the [Friendship](#friendship) section. + + | +
| + +`FOR TESTING` + + | + ++ +For [ABAP Unit](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/index.htm?file=abenabap_unit_glosry.htm) tests. Find more information in the [ABAP Unit Tests](14_ABAP_Unit_Tests.md) cheat sheet. + + | +
| + +`FOR BEHAVIOR OF` + + | + ++ +To define [ABAP behavior pools](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/index.htm?file=abenbehavior_pool_glosry.htm). Find more information in the [ABAP for RAP: Entity Manipulation Language (ABAP EML)](08_EML_ABAP_for_RAP.md) cheat sheet. + + | +
| + +`DEFINITION DEFERRED` + + | + ++ +Makes a local class known in a program before the actual class definition. It is typically used in test classes of ABAP Unit. Find more information [here](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/index.htm?file=abapclass_deferred.htm). + + | +
| Addition | Notes | +
| + +[`ALIASES ... FOR ...`](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/index.htm?file=abapaliases.htm) + + | + +
+
+Specifies alias names for the interface components. The components can then be addressed using the alias name.
+
+ + +```abap +"Local interface in a CCIMP include +INTERFACE lif. + METHODS some_method. + DATA some_string type string. +ENDINTERFACE. + +"Local class in a CCIMP include implementing the interface +CLASS lcl DEFINITION. + PUBLIC SECTION. + INTERFACES lif. + ALIASES meth FOR lif~some_method. + ALIASES str FOR lif~some_string. +ENDCLASS. + +CLASS lcl IMPLEMENTATION. + METHOD meth. + "This syntax is also possible: METHOD lif~some_method. + ... + DATA(string1) = str. + "This sytanx is also possible. However, when you have already addressed the component + "with the alias as in the assignment above, the following statement shows a syntax warning. + "DATA(string2) = lif~some_string. + ENDMETHOD. +ENDCLASS. +``` + + |
+
| + +[`ABSTRACT METHODS`](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/index.htm?file=abapinterfaces_class.htm) + + | + +
+
+- Specifies instance methods as abstract.
+- Multiple methods can be specified.
+- The addition can only be used when the whole class is defined as abstract.
+
+ + +``` abap +INTERFACE lif3. + METHODS meth1. + METHODS meth2. +ENDINTERFACE. + +"Local abstract class +"meth1 is specified as abstract method, meth2 is not. +"Therefore, only meth2 must be implemented. meth1 must +"be implemented by the subclasses. +CLASS lcl3 DEFINITION ABSTRACT. + PUBLIC SECTION. + INTERFACES lif3 ABSTRACT METHODS meth1. +ENDCLASS. + +CLASS lcl3 IMPLEMENTATION. + METHOD lif3~meth2. + ... + ENDMETHOD. +ENDCLASS. + +CLASS lcl4 DEFINITION INHERITING FROM lcl3. + PUBLIC SECTION. + METHODS lif3~meth1 REDEFINITION. +ENDCLASS. + +CLASS lcl4 IMPLEMENTATION. + METHOD lif3~meth1. + ... + ENDMETHOD. +ENDCLASS. +``` + + |
+
| + +[`ALL METHODS ABSTRACT`](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/index.htm?file=abapinterfaces_class.htm) + + | + +
+
+See above. With this addition, all methods are specified as abstract.
+
+ + +``` abap +INTERFACE lif. + METHODS meth1. + METHODS meth2. +ENDINTERFACE. + +"Local abstract class +"All methods are specified as abstract methods. +"Therefore, all methods of the interface must be implemented +"by the subclasses. +CLASS lcl1 DEFINITION ABSTRACT. + PUBLIC SECTION. + INTERFACES lif ALL METHODS ABSTRACT. +ENDCLASS. + +CLASS lcl1 IMPLEMENTATION. + +ENDCLASS. + +CLASS lcl2 DEFINITION INHERITING FROM lcl1. + PUBLIC SECTION. + METHODS lif~meth1 REDEFINITION. + METHODS lif~meth2 REDEFINITION. +ENDCLASS. + +CLASS lcl2 IMPLEMENTATION. + METHOD lif~meth1. + ... + ENDMETHOD. + + METHOD lif~meth2. + ... + ENDMETHOD. + +ENDCLASS. +``` + + |
+
| + +[`FINAL METHODS`](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/index.htm?file=abapinterfaces_class.htm) + + | + +
+
+Specifies methods as final so they cannot be further redefined. Multiple methods can be specified.
+
+ + +```abap +INTERFACE lif. + METHODS meth1. + METHODS meth2. +ENDINTERFACE. + +"meth1 is specified as final method, meth2 is not. +"Therefore, only meth2 can be further redefined in subclasses. +CLASS lcl1 DEFINITION. + PUBLIC SECTION. + INTERFACES lif FINAL METHODS meth1. +ENDCLASS. + +CLASS lcl1 IMPLEMENTATION. + + METHOD lif~meth1. + ... + ENDMETHOD. + + METHOD lif~meth2. + ... + ENDMETHOD. + +ENDCLASS. + +CLASS lcl2 DEFINITION INHERITING FROM lcl1. + PUBLIC SECTION. + "meth1 cannot be redefined as it is declared as final in the superclass. + "METHODS lif~meth1 REDEFINITION. + METHODS lif~meth2 REDEFINITION. +ENDCLASS. + +CLASS lcl2 IMPLEMENTATION. + + METHOD lif~meth2. + ... + ENDMETHOD. + +ENDCLASS. +``` + + |
+
| + +[`ALL METHODS FINAL`](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/index.htm?file=abapinterfaces_class.htm) + + | + +
+
+See above. With this addition, all methods are specified as final.
+
+ + +``` abap +INTERFACE lif. + METHODS meth1. + METHODS meth2. +ENDINTERFACE. + +"All methods are specified as final. Therefore, they +"cannot be further redefined in subclasses. +CLASS lcl1 DEFINITION. + PUBLIC SECTION. + INTERFACES lif ALL METHODS FINAL. + METHODS meth3. +ENDCLASS. + +CLASS lcl1 IMPLEMENTATION. + + METHOD lif~meth1. + ... + ENDMETHOD. + + METHOD lif~meth2. + ... + ENDMETHOD. + + METHOD meth3. + ... + ENDMETHOD. + +ENDCLASS. + +CLASS lcl2 DEFINITION INHERITING FROM lcl1. + PUBLIC SECTION. + "meth1 and meth2 cannot be redefined. + "METHODS lif~meth1 REDEFINITION. + "METHODS lif~meth2 REDEFINITION. + METHODS meth3 REDEFINITION. +ENDCLASS. + +CLASS lcl2 IMPLEMENTATION. + + METHOD meth3. + ... + ENDMETHOD. + +ENDCLASS. +``` + + |
+
| + +[`DATA VALUES`](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/ABAPINTERFACES_CLASS.html) + + | + +
+
+- Used to assign start values for attributes
+- Works in the style of `DATA ... VALUE ...` statements, e.g. `DATA number TYPE i VALUE 123`.
+
+ + +``` abap +INTERFACE lif. + METHODS meth1 RETURNING VALUE(result) TYPE i. + DATA num1 TYPE i. + DATA num2 TYPE i. + CLASS-DATA num3 TYPE i. +ENDINTERFACE. + +CLASS lcl1 DEFINITION. + PUBLIC SECTION. + INTERFACES lif DATA VALUES num1 = 1 num2 = 3 num3 = 6. +ENDCLASS. + +CLASS lcl1 IMPLEMENTATION. + + METHOD lif~meth1. + result = lif~num1 + lif~num2 + lif~num3. + ENDMETHOD. + +ENDCLASS. + +CLASS lcl3 DEFINITION. + PUBLIC SECTION. + CLASS-METHODS meth. +ENDCLASS. + +CLASS lcl3 IMPLEMENTATION. + + METHOD meth. + "result: 10 + DATA(result) = NEW lcl1( )->lif~meth1( ). + ENDMETHOD. + +ENDCLASS. +``` + + |
+
| + +[`PARTIALLY IMPLEMENTED`](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/ABAPINTERFACES_PARTIALLY.html) + + | + +
+
+- Relevant only for test classes.
+- When you use the `PARTIALLY IMPLEMENTED` addition in test classes, you are not forced to implement all of the concrete non-optional methods.
+- It is particularly useful for interfaces to implement test doubles, and not all methods are necessary.
+- See the [ABAP Unit Tests](14_ABAP_Unit_Tests.md) cheat sheet.
+
+ + +``` abap +"Test double class in a test include +CLASS ltd_test_double DEFINITION FOR TESTING. + PUBLIC SECTION. + INTERFACES some_intf PARTIALLY IMPLEMENTED. +ENDCLASS. + +CLASS ltd_test_double IMPLEMENTATION. + METHOD some_intf~some_meth. + ... + ENDMETHOD. +ENDCLASS. +``` + + |
+
|
+
+[`DEFAULT IGNORE`](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/index.htm?file=abapmethods_default.htm)
+
+ (addition used in the interface definition) + + |
+
+
+
+- Marks the implementation of methods as optional
+- Defines a default behavior when non-implemented methods are called. When a method with such a declaration is called without an implementation, it behaves as though no implementation exists.
+- Can only be used in interfaces for instance and static methods (except constructors and test methods)
+
+ + +``` abap +INTERFACE lif. + METHODS meth1 DEFAULT IGNORE. + METHODS meth2. +ENDINTERFACE. + +CLASS lcl1 DEFINITION. + PUBLIC SECTION. + INTERFACES lif. +ENDCLASS. + +"The class implementation does not include the optional +"implementation of lif~meth1. +CLASS lcl1 IMPLEMENTATION. + + METHOD lif~meth2. + ... + ENDMETHOD. + +ENDCLASS. + +CLASS lcl2 DEFINITION. + PUBLIC SECTION. + INTERFACES lif. +ENDCLASS. + +"The class implementation includes the optional +"implementation of lif~meth1. +CLASS lcl2 IMPLEMENTATION. + + METHOD lif~meth1. + ... + ENDMETHOD. + + METHOD lif~meth2. + ... + ENDMETHOD. + +ENDCLASS. + +CLASS lcl3 DEFINITION. + PUBLIC SECTION. + class-methods meth3. +ENDCLASS. + +"The class implementation includes the optional +"implementation of lif~meth1. +CLASS lcl3 IMPLEMENTATION. + + METHOD meth3. + DATA(oref1) = NEW lcl1( ). + DATA(oref2) = NEW lcl2( ). + + "Although not implemented, meth1 can be 'called' (i.e. + "it can be specified to be called). In this case, it is + "just like calling a method with empty implementation. + oref1->lif~meth1( ). + oref1->lif~meth2( ). + + "In this class, both methods are implemented. + oref2->lif~meth1( ). + oref2->lif~meth2( ). + + ENDMETHOD. + +ENDCLASS. +``` + + |
+
|
+
+[`DEFAULT FAIL`](https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/index.htm?file=abapmethods_default.htm)
+
+ (addition used in the interface definition) + + |
+
+
+
+See above. The behavior with this addition is that when an unimplemented method is called, the `CX_SY_DYN_CALL_ILLEGAL_METHOD` exception is raised.
+
+ + +``` abap +INTERFACE lif. + METHODS meth1 DEFAULT FAIL. + METHODS meth2. +ENDINTERFACE. + +CLASS lcl1 DEFINITION. + PUBLIC SECTION. + INTERFACES lif. +ENDCLASS. + +"The class implementation does not include the optional +"implementation of lif~meth1. +CLASS lcl1 IMPLEMENTATION. + + METHOD lif~meth2. + ... + ENDMETHOD. + +ENDCLASS. + +CLASS lcl2 DEFINITION. + PUBLIC SECTION. + INTERFACES lif. +ENDCLASS. + +"The class implementation includes the optional +"implementation of lif~meth1. +CLASS lcl2 IMPLEMENTATION. + + METHOD lif~meth1. + ... + ENDMETHOD. + + METHOD lif~meth2. + ... + ENDMETHOD. + +ENDCLASS. + +CLASS lcl3 DEFINITION. + PUBLIC SECTION. + CLASS-METHODS meth3. +ENDCLASS. + +"The class implementation includes the optional +"implementation of lif~meth1. +CLASS lcl3 IMPLEMENTATION. + + METHOD meth3. + DATA(oref1) = NEW lcl1( ). + DATA(oref2) = NEW lcl2( ). + + "Although not implemented, meth1 can be 'called' (i.e. + "it can be specified to be called). + "However, with the DEFAULT FAIL addition, an exception is + "raised. + TRY. + oref1->lif~meth1( ). + CATCH cx_sy_dyn_call_illegal_method INTO DATA(error). + DATA(error_text) = error->get_text( ). + ENDTRY. + oref1->lif~meth2( ). + + "In this class, both methods are implemented. + oref2->lif~meth1( ). + oref2->lif~meth2( ). + + ENDMETHOD. + +ENDCLASS. +``` + + |
+
CX_* CX_*, that serve as the basis for catchable exceptions. When an exception is raised, an object of such an exception class is created. There are several predefined exception classes. Find more information in the cheat sheet about program flow logic.
+Exception classes are special classes, usually starting with the name CX_*, that serve as the basis for catchable exceptions. When an exception is raised, an object of such an exception class is created. There are several predefined exception classes. Find more information in the [Exceptions and Runtime Errors](27_Exceptions.md) cheat sheet.
AMDP
Excursions into ABAP for Cloud Development
Excursions into ABAP for Cloud Development
"! "!The example class demonstrates released APIs and libraries with the restricted
"! ABAP language version.
@@ -431,7 +431,7 @@ CLASS zcl_demo_abap_cloud_excursion IMPLEMENTATION.
DATA(a4_del_cl) = a2_content-delivery_class->value.
DATA(a5_data_maint) = a2_content-data_maintenance->if_xco_printable~get_text( )->get_lines( )->join( )->value.
"Getting all fields of the database table
- "The handler is further processed. In the example, only the field names are retreived.
+ "The handler is further processed. In the example, only the field names are retrieved.
DATA(a6_fields) = db->fields->all->get( ).
CLEAR str.