Wood J. Object-Oriented Programming with ABAP Objects

Подождите немного. Документ загружается.

Getting Started with the Flight Query Report | 10.3

IMPORTING im_from TYPE s_airport

im_depart_date TYPE s_date

im_to TYPE s_airport

im_return_date TYPE s_date.

PRIVATE SECTION.

OATA: flight_model TYPE REF TO 1cl_f1ight_model.

flightjist TYPE ty_f1ight_list.

grid TYPE REF TO cl_salv_table.

METHODS:

show_grid.

ENOCLASS.

CLASS 1cl_query_ctrl IMPLEMENTATION.

METHOO constructor.

* Inititalize the flight model:

CREATE OBJECT f1ight_model.

ENDMETHOD.

METHOO do_display_report.

* Use the model method "query_f1ights" to query the

* flight database:

REFRESH flightjist.

CALL METHOD flight_model->query_flights

EXPORTING

im_from - im_from

im_depart_date - im_depart_date

im_to - im_to

im_return_date - im_return_date

IMPORTING

ex_results - flight_list.

* Display the result set in an ALV grid:

show_grid( ).

ENDMETHOD.

METHOD show_grid.

* Implementation deferred for now...

ENDMETHOD.

ENOCLASS. -lcl_query_ctrl

Listing 10.2 Implementing the Flight Query Controller Class

265

10 | Working with the SAP List Viewer

Normally, whenever an input event is triggered in the view, the controller

responds to that event by notifying the model and selecting the next appropriate

view for the user. In a typical ABAP report program, the initial view shown to a

user is a selection screen. In the flight queiy report, we will provide users with a

selection screen containing parameters that allow them to filter the flight query

results by destination and date range. After users enter this data, they can execute

the report by clicking on the EXECUTE button (see Figure 10.3).

I®

" .-.i cr. • sv-;t*fi H*U.

A " y ooe • . . BE ®a

ABAP 00 Flight Query Report

Figure 10.3 Defining Selection Criteria for the Flight Query Report

Whenever a user executes the report, the START-OF-SELECT I

event block is trig-

gered. In Listing 10.3,you can see that the ZALVFLIGHT report program is delegat-

ing this event to an instance of our custom lcl_query_ctr1 controller class by

calling instance method do_display_report.

*& *

*& Report ZALVFLIGHT *

** *

REPORT zalvflight.

INCLUDE zalvflight_classes.

DATA: lr_controller TYPE REF TO lcl_query_ctrl.

SELECTION SCREEN BEGIN OF BLOCK blk.main WITH FRAME.

SELECTION-SCREEN BEGIN OF LINE.

SELECTION-SCREEN COMMENT 1(5) textt02.

PARAMETERS p_from TYPE s_airport OBLIGATORY.

SELECTION SCREEN COMMENT 15(15) text t03.

PARAMETERS p_dptdat TYPE s_date.

266

Getting Started with the Flight Query Report | 10.3

SELECTION-SCREEN END OF LINE.

SELECTION-SCREEN BEGIN OF LINE.

SELECTION-SCREEN COMMENT 1(5) text-t04.

PARAMETERS p_tO TYPE s_dirport OBLIGATORY.

SELECTION-SCREEN COMMENT 15(15) text-t05.

PARAMETERS p.retdat TYPE s_date.

SELECTION-SCREEN END OF LINE.

SELECTION-SCREEN END OF BLOCK blk_main.

LOAD-OF-PROGRAM.

CREATE OBJECT 1r_control1er.

START-OF-SELECT ION.

CALL METHOD 1r_controller->do_display_report

EXPORTING

im_from - p_from

im_depart_date - p_dptdat

im_to - p_to

im_return_date - p_retdat.

Listing 10.3 Integrating the Controller into an Executable Report

Inside method do_display_report (refer to Listing 10.2), the provided selection

screen parameters are used to queiy the flight model. Here, as you saw in Listing

10.1, the query_flights method is calling the standard BAPI function

BAPI_FLIGHT_GETLIST to execute the flight query. The results are cached in the

private flight_list instance attribute defined in class lcl_query_ctrl.

After the flight model has been queried, the next task for the controller is to pro-

vide users with a view of the flight queiy list results. In this case, the view is

encapsulated inside of class CL_SALV_TABLE. The private helper method show_grid

of class lcl_query_ctrl is used to select this view for the users. We will look at

how to implement method show_grid in the following section.

10.3.5 Implementing the Report View

The simplicity of the ALV Object Model makes the view selection task for control-

ler class lcl_query_ctrl veiy straightforward. Listing 10.4 shows the implemen-

tation of the show_grid helper method that is used to display the flight query

results view.

267

10 | Working with the SAP List Viewer

CLASS lcl_query_ctrl IMPLEMENTATION.

METHOO show_grid.

* Method-Local Data Declarations:

OATA: lr_grid_ex TYPE REF TO cx_salv_msg.

lv_message TYPE string.

Ir_functions TYPE REF TO cl_sa1v_functions.

* Use the factory method to create an instance of the

* ALV grid:

TRY.

CALL METHOD cl_salv_table->factory

IMPORTING

r_salv_table - grid

CHANGING

t_table - filght_i1st.

CATCH cx_salv_msg INTO lr_grid_ex.

lv_message - 1r_grid_ex->get_text( ).

MESSAGE 1v_message TYPE 'I'.

RETURN.

ENDTRY.

* Enable the standard ALV toolbar:

1r_functions - grid->get_functions( ).

1r_functions->set_al1( abap_true ).

* Display the ALV grid:

grid->display( ).

ENDMETHOD.

ENOCLASS.

Listing 10.4 Displaying the Flight Query Results View

As you can see in Listing 10.4, the majority of the work is handled by the afore-

mentioned FACTORY method of class CL_SALV_TABLE. TO simplify the task of calling

this method, do the following:

1. Click on the PATTERN button in the ABAP Editor to call up the Insert Statement

wizard shown in Figure 10.4.

2. Select the ABAP OBJECTS PATTERNS button, and press Q-

268

Getting Started with the Flight Query Report 10.3

©•ins

CALL FUNCTION

ABAP Obiocts

Pan»ms

OMESSAOE

Q ABJECT* FROM

OPERFORM

O AUTHORITY CHECK

O WRITE

CASS

lot

ttMus

O Stinted Ditl 0fcn«t

wfli

flvklt

*om

ttructur*

OWFF.TYPEFC>-S1R\KT

CALL

DIAL00

OC9*fP««m

|MM

C*t E f*jrnb«f

Figure 10.4 Working with the ABAP Objects Pattern Generator — Part 1

3. This brings you to the 00 STATEMENT PATTERN dialog box shown in Figure 10.5.

This screen provides various options for generating method calls, raising

events, and so on

. Use the CALL METHOD pattern to build the syntax needed to

call method FACTORY of

class

CL_SALV_TABLE.

13'00

SUlgmffil

P aflein

®C»»M«KK>

iMtMC*

CUftArftrfact

CL_SJU.V_T*BLE

MMTiOd

FACTORY

Oci«i»oe<»<t

lmur.ee

CUtt I I

Raise

EvwU

ClKSJQrttrfac*

I I

Raise

wcwoon

Euepbon

class

0®

Figure 10.5 Working with the ABAP Objects Pattern Generator - Part 2

1 Note that the ABAP Objects pattern generator tool can only work with global classes defined in

the ABAP Repositoty.

269

10 | Working with the SAP List Viewer

After the grid object is instantiated, you can enable the standard ALV toolbar by

invoking method SET.ALL of class CL_SALV_FUNCTIONS. Figure 10.6 shows an

example of the report display generated by method show_grid.

utt Eat Goto Stmngi Sptw h»»

G ' J ©Q© Q ft]

ABAP 00 Flight Query Report

& V V 2

O a a

a 5 (to

A/r4fxan Art res

Ajr^rKin Arim

A/r«ncan Artre?

17 10/10/2007 JFK NEW YORK SFC SAN FRANC I5C0 000000 21 CO 00 1CU10QC07

17 11/07/2007 JFK NEW YORK SFC SAN FRANCISCO 000000 21COOO

17 12*05/2007 JFK NEW YORK SFC SAN FRANCISCO 00 00 00 210000

M UmfcanAm— 17

[01

<02/2008 JFK I NEW YORK [Of 0|8AN FRANCISCO 'OOOOOO 21

AA *A/r«fxanAr*r#s ' 17 01/3(1/2008 JFK*NEWYORK SFO* SAN FRANCISCO '00 00 00 21COOO

A/r*ocan Kf\m

A/r««canArtffs

:an Artr*j A/ntncJ

Amtncan Artr.e*

UmtflfnArtn—

17 03/26/2008 jFKjNCWYORK ISFOjSAN fRANttSCO 10000:00 pi oo.ool

wlwggOO^JfKlN^rYO^

21 CO

an Artres

an Ann**

17 CW2ir2008 JFK NEW YORK SFO<8glF^CgC^OOOO^

5/18/2008 JFK NEW YORK

an Artre*

-BIM ARTFM

SmificsnArtris 17

07/16/2008 JFK NEW YORK SFO SAN FRANCISCO 00 00 00

06/13/2008 JFK NEW YORK SFO SAN FRANCISCO 00 00 00 21 0000

09/10/2008 JFK NEW YORK SFC SAN FRANCISCO 00 00 00 21 00 00

10D8/2008 JFK NEW YORK SFC SAN FRANCISCO 00 00 00 2100 00

11105/2008 JFK NEW YORK SFO SAN FRANCISCO 00 00 00 21 0000

11A07/2C07

1205/2C07

01J02/2CC3

01/30f2CC3

02/27/2C03

03WK03

04/23*2008

05/21/21XS

07/I6f2i:03

08n*2l»8

08/1CV2C08

10C8/2CC8

11XW2CC8

422 8400 USD

422 9400'USD

422 9400 USD

4229400 USO

422 9400 USO

<22 9400 USD

422 9400 USO

422 9400'USD

422 9400 USD

422 9400 USO

422 9400 *USO

422 9400 USO

422 9400 *USO

422 9400 USD

Delia Airlines

1893 11*05/2007

1649 12*03/2007

JFK NEW YORK SFC SAN FRANCISCO 17 1500 2037 00 11J05/2C07

Delia Airlines

'0enaA4rines

De«a Airtnes

Delia Airlines

Delia Afiines

Delia Airlines

11699112^1/2007

1699101/28/2008

[169919205/2008

1699 03/24/2008

1699 04/21/2008

JFK NEW YORK SFO SA.N

FRANC

ISCO

7 16 10 20 «7 00

JFK'NEWYORK SFO'SANFRANCISCO 17 15 DO 20 37 00

1699

05/19/2008

06/16/2008

1699 07/14/2008

1699 OS/11/2008

JFK NEW YORK

JFK [NEW YORK

JFK NEW YORK*

JFK NEW YORK

SFOjSANFRANCISCO 17 1500 2037 00

TSfOjSANFRANCISCO 1715Q0 12037:001

jsFojsAN FRANCISCOM

'SFO'SANFRANCISCO

SFC SAN FRANCISCO

17 1500

2C37 00

171500

17:1500

SAN

FRANCISCO 171500

SFO SAN FRANCISCO 17 15 00

SFO* SAN FRANCISCO 17 1500

-2037:00

J-0

37 00

'20 37

20 37

2037 00

12XJ3/2C07

12/31/2CC7

01/20/2008

02/2V2C08

4229400 USO

422 9400 USD

422 8400 *USO

422 9400 USD

oynvmx 4229400 uso use

04/21/2CC*

06*16/2008

07/14/3C08

08J11/2C08

422 9400 USO

422 9400 *USO

422 9400 USD

422 9400

USO

| use

use

Figure 10.6 Displaying the Flight Query Results in an ALV Table

As you can see in Listing 10.4, shown earlier, there are few dependencies

between the CL_$ALV_TABLE view class and the underlying data model. In the

past, the coupling between the data model and the grid control was much tighter

because developers were forced to provide view metadata (i.e., the ALV field cat-

alog). Fortunately, with the encapsulation techniques employed in the design of

the ALV Object Model, SAP has eliminated these dependencies to make report

development much more flexible.

270

Event Handling with the ALV Object Model 10.4

10.4 Event Handling with the ALV Object Model

We made a lot of progress with the flight query report in Section 10.3, Getting

Started with the Flight Query Report. However, one requirement that we still

have not implemented is the event handling logic needed to display the number

of available seats whenever the user double-clicks on a flight in the report list. In

this section, we will rework the flight query report to use ABAP Objects eventing

functionality to satisfy this requirement.

10.4.1 Integrating Event Handler Methods into the Controller

Ifyou recall from Chapter 2. Working with Objects. ABAP Objects events are han-

dled by event handler methods. These methods are defined in terms of the inter-

face specified for the triggering event and can be created in any class that has vis-

ibility to the class that defines the event. In our report example, the natural

location for an event handler method is in the controller class.

Listing 10.5 shows that an event handler method called on_double_cl ick has

been added to class lcl_query_ctrl. This event handler method will respond to

the double_cl ick event defined in class Ci._SALV_EVENTS_TABLE. YOU will see how

to handle this event later in Section 10.4.3, Responding to Events.

CLASS lcl_query_ctrl DEFINITION.

PUBLIC SECTION.

METHODS:

constructor.

do_display_report

IMPORTING im_from TYPE s_airport

im_depart_date TYPE s_date

im_to TYPE s_airport

im_return_date TYPE s_date.

on_doub1e_cl 1ck FOR EVENT double.cllck

OF cl_salv_events_table

IMPORTING row

column

sender.

PRIVATE SECTION.

DATA: flight.model TYPE REF TO 1cl_f1ight_model.

flightjist TYPE ty_flight_l1st.

grid TYPE REF TO cl.salv_table.

271

Working with the SAP List Viewer

METHODS:

show_grid.

ENDCLASS.

Listing 10.5 Defining an Event Handler Method for the Report

10.4 2 Registering Event Handler Methods

Simply defining an event handler method as in Listing 10.5 does not register our

controller class as a listener for the D0UBLE_CLICK event of class

Cl_SAi V_EVENTS_TABl F. Instead, this registration must take place at runtime using

the SET HANDLER statement. Listing 10.6 shows how the controller method

on_double_click has been registered to listen for events triggered in class

CL_SALV_EVENTS_TABLE using the SET HANDLER statement.

METHOD show_grid.

* Method-Local Data Declarations:

DATA: lr_grid_ex TYPE REF TO cx_salv_msg.

lv_message TYPE string.

lr_functions TYPE REF TO cl_salv_functions.

lr_events TYPE REF TO cl_salv_events_table.

* Use the factory method to create an instance of the

* ALV grid:

TRY.

CALL METHOO cl_salv_table->factory

IMPORTING

r_salv_table - grid

CHANGING

t_table - flightjist.

CATCH cx_salv_msg INTO lr_grid_ex.

lv_message - 1r_grid_ex->get_text( ).

MESSAGE 1v_message TYPE 'I'.

RETURN.

ENDTRY.

* Enable the standard ALV toolbar:

lr_functions - grid->get_functions( ).

1r_functions->set_al1( abap_true ).

* Register the event handler method "on_double_click" so

* that we can respond to double-click events on the grid:

2 72

Event Handling with the ALV Object Model 10.4

lr_events - gr1d->get_event( ).

SET HANDLER me->on_double_cl1ck FOR lr.events.

* Display the ALV grid:

grid->display( ).

ENDMETHOD.

Listing 10.6 Registering the Controller as an Event Handler

10.4.3 Responding to Events

Now that we have registered our on_double_click event handler method, we

need to implement the logic necessary for displaying the number of available

seats on the flight selected by the user. Listing 10.7 shows an example of this

logic. Here, we use the importing row parameter provided by the event to deter-

mine which flight the user has selected in the flight query results. After wc have

this information, we can query table SFLIGHT to obtain additional information

about the flight. Here, we use the SEATSMAX and SEATSOCC fields to calculate the

number of available seats on the flight and then display the results in a pop-up

using the MESSAGE statement.

METHOD on_double_click.

* Method-Local Data Declarations:

DATA: ls_selected_flight TYPE bapisfldat.

ls_flight_info TYPE sflight.

1v_open_seats TYPE numc5.

lv_message TYPE string.

* Read the selected flight record from the model

* using the "row" index provided by the event:

READ TABLE flightjist

INDEX row

INTO ls_selected_flight.

* Use the key of the selected flight record to extract

* additional flight information from table SFLIGHT:

SELECT SINGLE *

INTO

s_f

ight Jnfo

FROM sflight

WHERE carrid EO 1s_selected.f1ight-airlineid

AND connid EO 1s_selected_f1ight-connectid

AND fldate EO ls_selected_flight-flightdate.

273

10 | Working with the SAP List Viewer

* Calculate the total number of available seats left

* on the flight:

lv_open_seats -

ls_flight_info-seatsmax - ls_flight_info-seatsocc.

SHIFT lv_open_seats LEFT DELETING LEADING '0'.

SHIFT ls_flight_info-connid LEFT DELETING LEADING '0'.

* Display the results in a pop-up message:

CONCATENATE 'There are'(OOl)

lv_open_seats

'seats available on Flight'(002)

ls_flight_info-connid

INTO lv_message

SEPARATED BY space.

MESSAGE

v_message TYPE T.

ENDMETHOD.

Listing 10.7 Implementing the Event Handler Method

10.4.4 Triggering Events on the Frontend

After we have activated all of the changes outlined in this section, we can execute

the report again to test the double_click event. Figure 10.7 shows the pop-up

message generated by double-clicking on a flight record in the search result list.

Behind the scenes, the SAP Control Framework is propagating the double_cl ick

event on the frontend ALV grid control back to the ABAP Objects Control

Framework. Internally, the event is captured inside an instance of the

CL_SAiV_EVENTS_TABLE and forwarded to our event handler method via method

RAISE_DOUBLE_CLICK. Here, method RAISE_DOUBLE_CLICK uses the RAISE EVENT

statement to trigger the instance event. The syntax for the RAISE EVENT statement

is shown in Listing 10.8.

RAISE EVENT evt

[EXPORTING

el - fl

e2 - f2

Listing 10.8 Syntax Diagram for the RAISE EVENT Statement

274