/AWS1/IF_TBD=>SEARCHTASKS()

About SearchTasks

Searches for tasks.

Method Signature

METHODS /AWS1/IF_TBD~SEARCHTASKS
  IMPORTING
    !IV_FARMID TYPE /AWS1/TBDFARMID OPTIONAL
    !IO_FILTEREXPRESSIONS TYPE REF TO /AWS1/CL_TBDSRCHGREDFILTXPRS OPTIONAL
    !IT_SORTEXPRESSIONS TYPE /AWS1/CL_TBDSEARCHSORTXPRSN=>TT_SEARCHSORTEXPRESSIONS OPTIONAL
    !IV_ITEMOFFSET TYPE /AWS1/TBDINTEGER OPTIONAL
    !IV_PAGESIZE TYPE /AWS1/TBDINTEGER OPTIONAL
    !IT_QUEUEIDS TYPE /AWS1/CL_TBDQUEUEIDS_W=>TT_QUEUEIDS OPTIONAL
    !IV_JOBID TYPE /AWS1/TBDJOBID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tbdsearchtasksrsp
  RAISING
    /AWS1/CX_TBDACCESSDENIEDEX
    /AWS1/CX_TBDINTERNALSERVERER00
    /AWS1/CX_TBDRESOURCENOTFOUNDEX
    /AWS1/CX_TBDTHROTTLINGEX
    /AWS1/CX_TBDVALIDATIONEX
    /AWS1/CX_TBDCLIENTEXC
    /AWS1/CX_TBDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_farmid TYPE /AWS1/TBDFARMID /AWS1/TBDFARMID

The farm ID of the task.

iv_itemoffset TYPE /AWS1/TBDINTEGER /AWS1/TBDINTEGER

The offset for the search results.

it_queueids TYPE /AWS1/CL_TBDQUEUEIDS_W=>TT_QUEUEIDS TT_QUEUEIDS

The queue IDs to include in the search.

Optional arguments:

io_filterexpressions TYPE REF TO /AWS1/CL_TBDSRCHGREDFILTXPRS /AWS1/CL_TBDSRCHGREDFILTXPRS

The search terms for a resource.

it_sortexpressions TYPE /AWS1/CL_TBDSEARCHSORTXPRSN=>TT_SEARCHSORTEXPRESSIONS TT_SEARCHSORTEXPRESSIONS

The search terms for a resource.

iv_pagesize TYPE /AWS1/TBDINTEGER /AWS1/TBDINTEGER

Specifies the number of results to return.

iv_jobid TYPE /AWS1/TBDJOBID /AWS1/TBDJOBID

The job ID for the task search.

RETURNING

oo_output TYPE REF TO /aws1/cl_tbdsearchtasksrsp /AWS1/CL_TBDSEARCHTASKSRSP

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->searchtasks(
  io_filterexpressions = new /aws1/cl_tbdsrchgredfiltxprs(
    it_filters = VALUE /aws1/cl_tbdsearchfilterxprsn=>tt_searchfilterexpressions(
      (
        new /aws1/cl_tbdsearchfilterxprsn(
          io_datetimefilter = new /aws1/cl_tbddatetimefiltxprsn(
            iv_datetime = '20150101000000.0000000'
            iv_name = |string|
            iv_operator = |string|
          )
          io_groupfilter = new /aws1/cl_tbdsrchgredfiltxprs( iv_operator = |string| )
          io_parameterfilter = new /aws1/cl_tbdparamfilterxprsn(
            iv_name = |string|
            iv_operator = |string|
            iv_value = |string|
          )
          io_searchtermfilter = new /aws1/cl_tbdsrchtermfiltxprsn(
            iv_matchtype = |string|
            iv_searchterm = |string|
          )
          io_stringfilter = new /aws1/cl_tbdstringfilterxprsn(
            iv_name = |string|
            iv_operator = |string|
            iv_value = |string|
          )
          io_stringlistfilter = new /aws1/cl_tbdstrlistfilterxprsn(
            it_values = VALUE /aws1/cl_tbdstringfilterlist_w=>tt_stringfilterlist(
              ( new /aws1/cl_tbdstringfilterlist_w( |string| ) )
            )
            iv_name = |string|
            iv_operator = |string|
          )
        )
      )
    )
    iv_operator = |string|
  )
  it_queueids = VALUE /aws1/cl_tbdqueueids_w=>tt_queueids(
    ( new /aws1/cl_tbdqueueids_w( |string| ) )
  )
  it_sortexpressions = VALUE /aws1/cl_tbdsearchsortxprsn=>tt_searchsortexpressions(
    (
      new /aws1/cl_tbdsearchsortxprsn(
        io_fieldsort = new /aws1/cl_tbdfieldsortxprsn(
          iv_name = |string|
          iv_sortorder = |string|
        )
        io_parametersort = new /aws1/cl_tbdparametersortxprsn(
          iv_name = |string|
          iv_sortorder = |string|
        )
        io_userjobsfirst = new /aws1/cl_tbduserjobsfirst( |string| )
      )
    )
  )
  iv_farmid = |string|
  iv_itemoffset = 123
  iv_jobid = |string|
  iv_pagesize = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_tasks( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_taskid = lo_row_1->get_taskid( ).
      lv_stepid = lo_row_1->get_stepid( ).
      lv_jobid = lo_row_1->get_jobid( ).
      lv_queueid = lo_row_1->get_queueid( ).
      lv_taskrunstatus = lo_row_1->get_runstatus( ).
      lv_tasktargetrunstatus = lo_row_1->get_targetrunstatus( ).
      LOOP AT lo_row_1->get_parameters( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_intstring = lo_value->get_int( ).
          lv_floatstring = lo_value->get_float( ).
          lv_parameterstring = lo_value->get_string( ).
          lv_pathstring = lo_value->get_path( ).
          lv_string = lo_value->get_chunkint( ).
        ENDIF.
      ENDLOOP.
      lv_taskretrycount = lo_row_1->get_failureretrycount( ).
      lv_startedat = lo_row_1->get_startedat( ).
      lv_endedat = lo_row_1->get_endedat( ).
      lv_updatedat = lo_row_1->get_updatedat( ).
      lv_updatedby = lo_row_1->get_updatedby( ).
      lv_sessionactionid = lo_row_1->get_latestsessionactionid( ).
    ENDIF.
  ENDLOOP.
  lv_nextitemoffset = lo_result->get_nextitemoffset( ).
  lv_totalresults = lo_result->get_totalresults( ).
ENDIF.