/AWS1/IF_LIC=>CHECKOUTBORROWLICENSE()

About CheckoutBorrowLicense

Checks out the specified license for offline use.

Method Signature

METHODS /AWS1/IF_LIC~CHECKOUTBORROWLICENSE
  IMPORTING
    !IV_LICENSEARN TYPE /AWS1/LICARN OPTIONAL
    !IT_ENTITLEMENTS TYPE /AWS1/CL_LICENTITLEMENTDATA=>TT_ENTITLEMENTDATALIST OPTIONAL
    !IV_DIGITALSIGNATUREMETHOD TYPE /AWS1/LICDIGITALSIGMETHOD OPTIONAL
    !IV_NODEID TYPE /AWS1/LICSTRING OPTIONAL
    !IT_CHECKOUTMETADATA TYPE /AWS1/CL_LICMETADATA=>TT_METADATALIST OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/LICCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_liccheckoutborrowli01
  RAISING
    /AWS1/CX_LICACCESSDENIEDEX
    /AWS1/CX_LICAUTHEXCEPTION
    /AWS1/CX_LICENTITLEMENTNOTAL00
    /AWS1/CX_LICINVPARAMVALUEEX
    /AWS1/CX_LICNOENTITLEMENTSAL00
    /AWS1/CX_LICRLIMEXCEEDEDEX
    /AWS1/CX_LICREDIRECTEXCEPTION
    /AWS1/CX_LICRESOURCENOTFOUNDEX
    /AWS1/CX_LICSERVERINTERNALEX
    /AWS1/CX_LICUNSUPPEDDIGITALS00
    /AWS1/CX_LICVALIDATIONEX
    /AWS1/CX_LICCLIENTEXC
    /AWS1/CX_LICSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_licensearn TYPE /AWS1/LICARN /AWS1/LICARN

Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.

it_entitlements TYPE /AWS1/CL_LICENTITLEMENTDATA=>TT_ENTITLEMENTDATALIST TT_ENTITLEMENTDATALIST

License entitlements. Partial checkouts are not supported.

iv_digitalsignaturemethod TYPE /AWS1/LICDIGITALSIGMETHOD /AWS1/LICDIGITALSIGMETHOD

Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS.

iv_clienttoken TYPE /AWS1/LICCLIENTTOKEN /AWS1/LICCLIENTTOKEN

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Optional arguments:

iv_nodeid TYPE /AWS1/LICSTRING /AWS1/LICSTRING

Node ID.

it_checkoutmetadata TYPE /AWS1/CL_LICMETADATA=>TT_METADATALIST TT_METADATALIST

Information about constraints.

RETURNING

oo_output TYPE REF TO /aws1/cl_liccheckoutborrowli01 /AWS1/CL_LICCHECKOUTBORROWLI01

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->checkoutborrowlicense(
  it_checkoutmetadata = VALUE /aws1/cl_licmetadata=>tt_metadatalist(
    (
      new /aws1/cl_licmetadata(
        iv_name = |string|
        iv_value = |string|
      )
    )
  )
  it_entitlements = VALUE /aws1/cl_licentitlementdata=>tt_entitlementdatalist(
    (
      new /aws1/cl_licentitlementdata(
        iv_name = |string|
        iv_unit = |string|
        iv_value = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_digitalsignaturemethod = |string|
  iv_licensearn = |string|
  iv_nodeid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_licensearn( ).
  lv_string = lo_result->get_licenseconsumptiontoken( ).
  LOOP AT lo_result->get_entitlementsallowed( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_name( ).
      lv_string = lo_row_1->get_value( ).
      lv_entitlementdataunit = lo_row_1->get_unit( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nodeid( ).
  lv_signedtoken = lo_result->get_signedtoken( ).
  lv_iso8601datetime = lo_result->get_issuedat( ).
  lv_iso8601datetime = lo_result->get_expiration( ).
  LOOP AT lo_result->get_checkoutmetadata( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_string = lo_row_3->get_name( ).
      lv_string = lo_row_3->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.