/AWS1/IF_OSR=>GETCAPABILITY()

About GetCapability

Retrieves information about a registered capability for an OpenSearch UI application, including its configuration and current status.

Method Signature

METHODS /AWS1/IF_OSR~GETCAPABILITY
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/OSRAPPLICATIONID OPTIONAL
    !IV_CAPABILITYNAME TYPE /AWS1/OSRCAPABILITYNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osrgetcapabresponse
  RAISING
    /AWS1/CX_OSRACCESSDENIEDEX
    /AWS1/CX_OSRDISABLEDOPEX
    /AWS1/CX_OSRINTERNALEXCEPTION
    /AWS1/CX_OSRRESOURCENOTFOUNDEX
    /AWS1/CX_OSRVALIDATIONEX
    /AWS1/CX_OSRCLIENTEXC
    /AWS1/CX_OSRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_applicationid TYPE /AWS1/OSRAPPLICATIONID /AWS1/OSRAPPLICATIONID

The unique identifier of the OpenSearch UI application.

iv_capabilityname TYPE /AWS1/OSRCAPABILITYNAME /AWS1/OSRCAPABILITYNAME

The name of the capability to retrieve information about.

RETURNING

oo_output TYPE REF TO /aws1/cl_osrgetcapabresponse /AWS1/CL_OSRGETCAPABRESPONSE

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->getcapability(
  iv_applicationid = |string|
  iv_capabilityname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_capabilityname = lo_result->get_capabilityname( ).
  lv_applicationid = lo_result->get_applicationid( ).
  lv_capabilitystatus = lo_result->get_status( ).
  lo_capabilityextendedrespo = lo_result->get_capabilityconfig( ).
  IF lo_capabilityextendedrespo IS NOT INITIAL.
    lo_aiconfig = lo_capabilityextendedrespo->get_aiconfig( ).
    IF lo_aiconfig IS NOT INITIAL.
    ENDIF.
  ENDIF.
  LOOP AT lo_result->get_failures( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_capabilityfailurereason = lo_row_1->get_reason( ).
      lv_capabilityfailuredetail = lo_row_1->get_details( ).
    ENDIF.
  ENDLOOP.
ENDIF.