DESCRIBESEARCH()`¶

About DescribeSearch¶

Returns the current status and metadata of a single search, including the query that was submitted, the search type, and — when the search has failed — the reason. Use this to poll a search started with StartSearch until it reaches a terminal status (SUCCEEDED or FAILED).

Method Signature¶

METHODS /AWS1/IF_IOS~DESCRIBESEARCH
  IMPORTING
    !IV_WORKSPACENAME TYPE /AWS1/IOSWORKSPACENAME OPTIONAL
    !IV_SEARCHID TYPE /AWS1/IOSSEARCHID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iosdescrsearchrsp
  RAISING
    /AWS1/CX_IOSACCESSDENIEDEX
    /AWS1/CX_IOSINTERNALFAILUREEX
    /AWS1/CX_IOSINVALIDREQUESTEX
    /AWS1/CX_IOSRESOURCENOTFOUNDEX
    /AWS1/CX_IOSTHROTTLINGEX
    /AWS1/CX_IOSCLIENTEXC
    /AWS1/CX_IOSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_workspacename` `TYPE /AWS1/IOSWORKSPACENAME` `/AWS1/IOSWORKSPACENAME`¶

The name of the workspace the search belongs to.

`iv_searchid` `TYPE /AWS1/IOSSEARCHID` `/AWS1/IOSSEARCHID`¶

The identifier of the search to describe.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iosdescrsearchrsp` `/AWS1/CL_IOSDESCRSEARCHRSP`¶

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->describesearch(
  iv_searchid = |string|
  iv_workspacename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_searchid = lo_result->get_searchid( ).
  lv_workspacename = lo_result->get_workspacename( ).
  lv_searchstatus = lo_result->get_status( ).
  lv_searchquerystatement = lo_result->get_querystatement( ).
  lv_searchtype = lo_result->get_searchtype( ).
  lv_string = lo_result->get_statusreason( ).
  lv_timestamp = lo_result->get_startedat( ).
  lv_groupid = lo_result->get_groupid( ).
ENDIF.

/AWS1/IF_IOS=>DESCRIBESEARCH()¶