BSP: Data exchange between (sub)Controllers - Part II (using OO Design Patterns )

[Former Member]

I would like to introduce the basic concept of Object Oriented Design Pattern  “Program to an Interface, not an implementation” in our application.

To make the application in Part I more flexible, create an interface ZIF_DATA_EXCHANGE, with method signatures  GET_CUSTOMER_ID and SET_CUSTOMER_ID with customerid type string as parameter. The objective of the interface is to provide methods that will be implemented by the classes (controllers)  to exchange the data .  In our case all of the controllers are going to implement the interface depending on the method of data transfer.

Implement the interface in main.do, so that the methods in the interface are available for redefining in the controllers for implementation.

Now, consider the three methods of data transfer explained in PART I.

Method 1.

1.Create an attribute CUSTOMERID in main.do
2.Redefine methods SET_CUSTOMERID and GET_CUSTOMERID in main.do as below. DATA: lo_parent_int     type ref to   ZIF_DATA_EXCHANGE.   See above interface is referenced instead of implementation class main.do    method ZIF_DATA_EXCHANGE~SET_CUSTOMERID.    me->customerid = customerid.    endmethod.   method ZIF_DATA_EXCHANGE~GET_CUSTOMERID.     customerid = me->customerid.  endmethod.

Now get the instance of the interface that was implemented in main.do and code to the interface as per Design Patterns.

3.     In DO_HANDLE_EVENT of LIST.Do capture the row selected event and set the parent controllers attribute CUSTOMERID with customer id of selected row by calling the interface method SET_CUSTOMERID implemented in main.do.

try.    lo_parent_int ?= m_parent.     If lo_parent_int  is bound.     lo_parent_int ->set_customerid(      exporting        CUSTOMERID = customerid from the selected row           ).     endif. endtry.

4.     In DO_INIT_ATTRIBUTES of details.do, get the customer id from parent controller that was set by the list selection event.

DATA: lo_parent_int     type ref to   ZIF_DATA_EXCHANGE.  try.    lo_parent_int ?= m_parent.     If lo_parent_int is bound.    lo_parent_int ->get_customerid(      IMPORTING        CUSTOMERID = me->custimerid           ).    endif. endtry.

Get the customer details based on me->customerid to display in the page. 

Method 2. (Push Method)

The rowselect event in list.do accesses the implementation class in main.do and sets the attribute's value in detail.do

Assumption is that the component id for details list is defined as ‘detail.
1.     Interface ZIF_DATA_EXCHANGE should be implemented in controllers main.do as shown.DATA: lo_details_int     type ref to   ZIF_DATA_EXCHANGE.  try.           Read table lo_main->m_subcontrollers into ls_sub where comp_id = ‘detail’.  If sy-subrc eq 0.      try.         lo_details_int     ?= ls_sub-instance.                If lo_details_int     is bound.         lo_details_int->set_customerid(           exporting             CUSTOMERID = customerid from the selected row           ).       endif.     catch cx_root.     endtry.   endif.    catch cx_root. endtry.

In Details.do implement the interface method SET_CUSTOMERID  should be as shown below to set the customerid attribute in details.do controller.

method ZIF_DATA_EXCHANGE~SET_CUSTOMERID.     me->customerid = customerid.  endmethod.

Method 3. (Pull Method).

This is implemented in DO_INIT_ATTRIBUTES of details.do . Gets the attribute from list.do by using the implementation method in parent controller main.do Assumption is that the component id for details list is defined as ‘list’.

DATA: lo_list_int     type ref to   ZIF_DATA_EXCHANGE.        try.                   lo_list_int     ?= m_parent. Read table lo_main->m_subcontrollers into ls_sub where  comp_id = ‘list’.     If sy-subrc eq 0.      try.         lo_list_int     ?= ls_sub-instance.         If lo_list_int     is bound.         lo_list_int->get_customerid(           importing             CUSTOMERID = me->customerid             ).        endif.       catch cx_root.      endtry    endif.     catch cx_root.   endtry.

In list.do implement the interface method GET_CUSTOMERID  should be as shown below to get the customerid attribute .method ZIF_DATA_EXCHANGE~GET_CUSTOMERID.      Customerid = me->customerid.  endmethod.

In all of the above methods, only instance of Interface methods are obtained not the instance of concrete class(main.do as in Part I ) methods. If another application were to call details.do directly, with out changing the code in details.do, the calling application can set the attribute by implementing interface ZIF_DATA_EXCHANGE .