Skip to content

/AWS1/IF_PTB=>GETBENEFIT()

About GetBenefit

Retrieves detailed information about a specific benefit available in the partner catalog.

Method Signature

METHODS /AWS1/IF_PTB~GETBENEFIT
  IMPORTING
    !IV_CATALOG TYPE /AWS1/PTBCATALOGNAME OPTIONAL
    !IV_IDENTIFIER TYPE /AWS1/PTBSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ptbgetbenefitoutput
  RAISING
    /AWS1/CX_PTBACCESSDENIEDEX
    /AWS1/CX_PTBINTERNALSERVEREX
    /AWS1/CX_PTBRESOURCENOTFOUNDEX
    /AWS1/CX_PTBTHROTTLINGEX
    /AWS1/CX_PTBVLDTNEXCEPTION
    /AWS1/CX_PTBCLIENTEXC
    /AWS1/CX_PTBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_catalog TYPE /AWS1/PTBCATALOGNAME /AWS1/PTBCATALOGNAME

The catalog identifier that specifies which benefit catalog to query.

iv_identifier TYPE /AWS1/PTBSTRING /AWS1/PTBSTRING

The unique identifier of the benefit to retrieve.

RETURNING

oo_output TYPE REF TO /aws1/cl_ptbgetbenefitoutput /AWS1/CL_PTBGETBENEFITOUTPUT

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->getbenefit(
  iv_catalog = |string|
  iv_identifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_id( ).
  lv_catalogname = lo_result->get_catalog( ).
  lv_string = lo_result->get_arn( ).
  lv_string = lo_result->get_name( ).
  lv_string = lo_result->get_description( ).
  LOOP AT lo_result->get_programs( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_program = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_fulfillmenttypes( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_fulfillmenttype = lo_row_3->get_value( ).
    ENDIF.
  ENDLOOP.
  lo_value = lo_result->get_benefitrequestschema( ).
  IF lo_value IS NOT INITIAL.
  ENDIF.
  lv_benefitstatus = lo_result->get_status( ).
ENDIF.