Skip to content

/AWS1/CL_FRM=>LISTHOOKRESULTS()

About ListHookResults

Returns summaries of invoked Hooks when a change set or Cloud Control API operation target is provided.

Method Signature

IMPORTING

Required arguments:

iv_targettype TYPE /AWS1/FRMLISTHOOKRSLTSTGTTYPE /AWS1/FRMLISTHOOKRSLTSTGTTYPE

The type of operation being targeted by the Hook.

iv_targetid TYPE /AWS1/FRMHOOKRESULTID /AWS1/FRMHOOKRESULTID

The logical ID of the target the operation is acting on by the Hook. If the target is a change set, it's the ARN of the change set.

If the target is a Cloud Control API operation, this will be the HookRequestToken returned by the Cloud Control API operation request. For more information on the HookRequestToken, see ProgressEvent.

Optional arguments:

iv_nexttoken TYPE /AWS1/FRMNEXTTOKEN /AWS1/FRMNEXTTOKEN

A string that identifies the next page of events that you want to retrieve.

RETURNING

oo_output TYPE REF TO /aws1/cl_frmlisthookrsltsout /AWS1/CL_FRMLISTHOOKRSLTSOUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_frm~listhookresults(
  iv_nexttoken = |string|
  iv_targetid = |string|
  iv_targettype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_listhookresultstargetty = lo_result->get_targettype( ).
  lv_hookresultid = lo_result->get_targetid( ).
  LOOP AT lo_result->get_hookresults( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_hookinvocationpoint = lo_row_1->get_invocationpoint( ).
      lv_hookfailuremode = lo_row_1->get_failuremode( ).
      lv_hooktypename = lo_row_1->get_typename( ).
      lv_hooktypeversionid = lo_row_1->get_typeversionid( ).
      lv_hooktypeconfigurationve = lo_row_1->get_typeconfversionid( ).
      lv_hookstatus = lo_row_1->get_status( ).
      lv_hookstatusreason = lo_row_1->get_hookstatusreason( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.