Ticket App

" @keywords rap business events ticket raise publish
" @summary every create and update raises an entity event
CLASS z2ui5_cl_smps_app_011 DEFINITION PUBLIC CREATE PUBLIC.

  PUBLIC SECTION.
    INTERFACES z2ui5_if_app.

    TYPES:
      BEGIN OF ty_s_ticket,
        ticket_uuid TYPE string,
        title       TYPE z2ui5_e_smps_title,
        priority    TYPE z2ui5_e_smps_priority,
        status      TYPE z2ui5_e_smps_status,
        created_by  TYPE syuname,
      END OF ty_s_ticket.
    DATA mt_tickets TYPE STANDARD TABLE OF ty_s_ticket WITH EMPTY KEY.

    TYPES:
      BEGIN OF ty_s_create,
        title    TYPE string,
        priority TYPE string,
        status   TYPE string,
      END OF ty_s_create.
    DATA ms_create TYPE ty_s_create.

  PROTECTED SECTION.
    DATA client TYPE REF TO z2ui5_if_client.

    METHODS on_init.
    METHODS on_event.
    METHODS on_event_create.
    METHODS on_event_update.
    METHODS data_read.
    METHODS view_display.

    "! what to say when the business object refused a create or an update:
    "! its own message where it sent one - a lock held by a draft of another
    "! user, say - rather than a bare "failed"
    "! @parameter action | Create or Update, the start of the text
    "! @parameter msg | the first message of REPORTED, unbound when it is empty
    "! @parameter result | the text for the message box
    METHODS failure_text
      IMPORTING
        action        TYPE string
        msg           TYPE REF TO if_abap_behv_message
      RETURNING
        VALUE(result) TYPE string.

  PRIVATE SECTION.
ENDCLASS.


CLASS z2ui5_cl_smps_app_011 IMPLEMENTATION.

  METHOD z2ui5_if_app~main.
    me->client = client.
    IF client->check_on_init( ).
      ms_create = VALUE #( priority = `M` status = `NEW` ).
      on_init( ).
    ELSEIF client->check_on_navigated( ).
      view_display( ).
    ELSEIF client->check_on_event( ).
      on_event( ).
    ENDIF.
  ENDMETHOD.

  METHOD on_init.
    data_read( ).
    view_display( ).
  ENDMETHOD.

  METHOD on_event.
    CASE client->get_event( ).
      WHEN `CREATE`.
        on_event_create( ).
      WHEN `UPDATE`.
        on_event_update( ).
      WHEN `REFRESH`.
        data_read( ).
        view_display( ).
    ENDCASE.
  ENDMETHOD.

  METHOD on_event_create.
    IF ms_create-title IS INITIAL.
      client->message_toast_display( `Please enter a title` ).
      RETURN.
    ENDIF.

    " Create a ticket via the RAP business object -> raises the RAP business event
    MODIFY ENTITIES OF z2ui5_r_smps_tck
      ENTITY Ticket
        CREATE FIELDS ( title priority status )
        WITH VALUE #( ( %cid     = `CID_TICKET`
                        title    = ms_create-title
                        priority = ms_create-priority
                        status   = ms_create-status ) )
      FAILED DATA(failed)
      REPORTED DATA(reported).

    IF failed-ticket IS NOT INITIAL.
      DATA(text) = failure_text( action = `Create`
                                 msg    = VALUE #( reported-ticket[ 1 ]-%msg OPTIONAL ) ).
      ROLLBACK ENTITIES.
      client->message_box_display( text = text type = `error` ).
      RETURN.
    ENDIF.

    COMMIT ENTITIES RESPONSE OF z2ui5_r_smps_tck
      FAILED DATA(commit_failed)
      REPORTED DATA(commit_reported).

    IF commit_failed IS INITIAL.
      client->message_toast_display( |Ticket '{ ms_create-title }' created - business event fired| ).
      ms_create = VALUE #( priority = `M` status = `NEW` ).
      data_read( ).
      view_display( ).
    ELSE.
      text = failure_text( action = `Create`
                           msg    = VALUE #( commit_reported-ticket[ 1 ]-%msg OPTIONAL ) ).
      ROLLBACK ENTITIES.
      client->message_box_display( text = text type = `error` ).
    ENDIF.
  ENDMETHOD.

  METHOD on_event_update.
    " OPTIONAL: the uuid comes from the client, and the row it names may be
    " gone by now - deleted in another session, or out of the top 50
    DATA(uuid) = client->get_event_arg( ).
    DATA(s_ticket) = VALUE #( mt_tickets[ ticket_uuid = uuid ] OPTIONAL ).
    IF s_ticket IS INITIAL.
      client->message_toast_display( `Ticket not found - press refresh` ).
      RETURN.
    ENDIF.

    " Update the status via the RAP business object -> the additional save
    " sees the update and raises the data event StatusChanged with its payload
    MODIFY ENTITIES OF z2ui5_r_smps_tck
      ENTITY Ticket
        UPDATE FIELDS ( status )
        WITH VALUE #( ( ticketuuid = s_ticket-ticket_uuid
                        status     = s_ticket-status ) )
      FAILED DATA(failed)
      REPORTED DATA(reported).

    IF failed-ticket IS NOT INITIAL.
      DATA(text) = failure_text( action = `Update`
                                 msg    = VALUE #( reported-ticket[ 1 ]-%msg OPTIONAL ) ).
      ROLLBACK ENTITIES.
      client->message_box_display( text = text type = `error` ).
      RETURN.
    ENDIF.

    COMMIT ENTITIES RESPONSE OF z2ui5_r_smps_tck
      FAILED DATA(commit_failed)
      REPORTED DATA(commit_reported).

    IF commit_failed IS INITIAL.
      client->message_toast_display( |Ticket '{ s_ticket-title }' set to { s_ticket-status } - business event fired| ).
      data_read( ).
      view_display( ).
    ELSE.
      text = failure_text( action = `Update`
                           msg    = VALUE #( commit_reported-ticket[ 1 ]-%msg OPTIONAL ) ).
      ROLLBACK ENTITIES.
      client->message_box_display( text = text type = `error` ).
    ENDIF.
  ENDMETHOD.

  METHOD data_read.
    SELECT FROM z2ui5_t_smps_tck                        "#EC CI_NOWHERE
      FIELDS ticket_uuid, title, priority, status, created_by
      ORDER BY created_at DESCENDING
      INTO TABLE @DATA(t_result)
      UP TO 50 ROWS.

    " the key travels to the browser as text - a RAW16 has no JSON form
    mt_tickets = VALUE #( FOR s_result IN t_result
        ( ticket_uuid = |{ s_result-ticket_uuid }|
          title       = s_result-title
          priority    = s_result-priority
          status      = s_result-status
          created_by  = s_result-created_by ) ).
  ENDMETHOD.

  METHOD failure_text.

    IF msg IS BOUND.
      result = |{ action } refused by the business object: { msg->if_message~get_text( ) }|.
    ELSE.
      " FAILED without a message in REPORTED - say that much rather than
      " leave the reader with a bare "failed"
      result = |{ action } refused by the business object, which sent no message with it|.
    ENDIF.

  ENDMETHOD.

  METHOD view_display.
    DATA(view) = z2ui5_cl_ui5_view_builder=>factory(
        )->ele( n = `View` ns = `mvc`
            )->a( n = `displayBlock` v = `true`
            )->a( n = `height`       v = `100%`
            )->a( n = `xmlns`        v = `sap.m`
            )->a( n = `xmlns:mvc`    v = `sap.ui.core.mvc`
            )->a( n = `xmlns:form`   v = `sap.ui.layout.form` ).
    DATA(page) = view->ele( `Shell`
        )->ele( `Page`
            )->a( n = `title`          v = `abap2UI5 - Business Events - Tickets`
            )->a( n = `showNavButton`  b = client->check_app_prev_stack( )
            )->a( n = `navButtonPress` v = client->_event_nav_app_leave( ) ).

    page->tag( `MessageStrip`
        )->a( n = `text`     v = `Create a ticket and the business object raises the notification event TicketCreated. ` &&
                                 `Change a status in the table and press Update Status, and it raises the data event ` &&
                                 `StatusChanged with the new values. What the handler made of both is in the event log ` &&
                                 `app - open it in a second tab and press refresh there.`
        )->a( n = `type`     v = `Information`
        )->a( n = `showIcon` v = `true`
        )->a( n = `class`    v = `sapUiSmallMargin` ).

    " --- create form ---
    page->ele( n = `SimpleForm` ns = `form`
        )->a( n = `editable` b = abap_true
        )->ele( n = `content` ns = `form`
            )->tag( `Label`
                )->a( n = `text` v = `Title`
            )->tag( `Input`
                )->a( n = `value` v = client->_bind( ms_create-title )
            )->tag( `Label`
                )->a( n = `text` v = `Priority (H / M / L)`
            )->tag( `Input`
                )->a( n = `value` v = client->_bind( ms_create-priority )
            )->tag( `Label`
                )->a( n = `text` v = `Status`
            )->tag( `Input`
                )->a( n = `value` v = client->_bind( ms_create-status )
            )->tag( `Button`
                )->a( n = `press` v = client->_event( `CREATE` )
                )->a( n = `text`  v = `Create Ticket`
                )->a( n = `type`  v = `Emphasized` ).

    " --- tickets table ---
    DATA(table) = page->ele( `Table`
        )->a( n = `items`      v = client->_bind( mt_tickets )
        )->a( n = `noDataText` v = `No tickets yet - create one above` ).
    table->ele( `headerToolbar`
        )->ele( `Toolbar`
            )->tag( `Title`
                )->a( n = `text` v = `Tickets`
            )->tag( `ToolbarSpacer`
            )->tag( `Button`
                )->a( n = `press`   v = client->_event( `REFRESH` )
                )->a( n = `icon`    v = `sap-icon://refresh`
                )->a( n = `tooltip` v = `Refresh` ).

    table->ele( `columns`
        )->ele( `Column`
            )->tag( `Text`
                )->a( n = `text` v = `Title`
        )->end(
        )->ele( `Column`
            )->tag( `Text`
                )->a( n = `text` v = `Priority`
        )->end(
        )->ele( `Column`
            )->tag( `Text`
                )->a( n = `text` v = `Status`
        )->end(
        )->ele( `Column`
            )->tag( `Text`
                )->a( n = `text` v = `Created By`
        )->end(
        )->ele( `Column`
            )->tag( `Text`
                )->a( n = `text` v = `` ).

    table->ele( `items`
        )->ele( `ColumnListItem`
            )->ele( `cells`
                )->tag( `Text`
                    )->a( n = `text` v = `{TITLE}`
                )->tag( `Text`
                    )->a( n = `text` v = `{PRIORITY}`
                )->tag( `Input`
                    )->a( n = `value` v = `{STATUS}`
                )->tag( `Text`
                    )->a( n = `text` v = `{CREATED_BY}`
                )->tag( `Button`
                    )->a( n = `press` v = client->_event( val = `UPDATE`
                                            arg = `${TICKET_UUID}` )
                    )->a( n = `text`  v = `Update Status` ).

    client->view_display( view->stringify( ) ).
  ENDMETHOD.

ENDCLASS.