/AWS1/IF_TBD=>SEARCHJOBS()

About SearchJobs

Searches for jobs.

Method Signature

METHODS /AWS1/IF_TBD~SEARCHJOBS
  IMPORTING
    !IV_FARMID TYPE /AWS1/TBDFARMID OPTIONAL
    !IT_QUEUEIDS TYPE /AWS1/CL_TBDQUEUEIDS_W=>TT_QUEUEIDS 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
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tbdsearchjobsresponse
  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 job.

it_queueids TYPE /AWS1/CL_TBDQUEUEIDS_W=>TT_QUEUEIDS TT_QUEUEIDS

The queue ID to use in the job search.

iv_itemoffset TYPE /AWS1/TBDINTEGER /AWS1/TBDINTEGER

Defines how far into the scrollable list to start the return of results.

Optional arguments:

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

The filter expression, AND or OR, to use when searching among a group of search strings in a resource.

You can use two groupings per search each within parenthesis ().

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 items per page for the resource.

RETURNING

oo_output TYPE REF TO /aws1/cl_tbdsearchjobsresponse /AWS1/CL_TBDSEARCHJOBSRESPONSE

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->searchjobs(
  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|
          )
        )
      )
    )
    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_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_jobs( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_jobid = lo_row_1->get_jobid( ).
      lv_queueid = lo_row_1->get_queueid( ).
      lv_jobname = lo_row_1->get_name( ).
      lv_joblifecyclestatus = lo_row_1->get_lifecyclestatus( ).
      lv_string = lo_row_1->get_lifecyclestatusmessage( ).
      lv_taskrunstatus = lo_row_1->get_taskrunstatus( ).
      lv_jobtargettaskrunstatus = lo_row_1->get_targettaskrunstatus( ).
      LOOP AT lo_row_1->get_taskrunstatuscounts( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_integer = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_taskfailureretrycount = lo_row_1->get_taskfailureretrycount( ).
      lv_jobpriority = lo_row_1->get_priority( ).
      lv_maxfailedtaskscount = lo_row_1->get_maxfailedtaskscount( ).
      lv_maxretriespertask = lo_row_1->get_maxretriespertask( ).
      lv_createdby = lo_row_1->get_createdby( ).
      lv_createdat = lo_row_1->get_createdat( ).
      lv_endedat = lo_row_1->get_endedat( ).
      lv_startedat = lo_row_1->get_startedat( ).
      lv_updatedat = lo_row_1->get_updatedat( ).
      lv_updatedby = lo_row_1->get_updatedby( ).
      LOOP AT lo_row_1->get_jobparameters( ) into ls_row_3.
        lv_key_1 = ls_row_3-key.
        lo_value_1 = ls_row_3-value.
        IF lo_value_1 IS NOT INITIAL.
          lv_intstring = lo_value_1->get_int( ).
          lv_floatstring = lo_value_1->get_float( ).
          lv_parameterstring = lo_value_1->get_string( ).
          lv_pathstring = lo_value_1->get_path( ).
        ENDIF.
      ENDLOOP.
      lv_maxworkercount = lo_row_1->get_maxworkercount( ).
      lv_jobid = lo_row_1->get_sourcejobid( ).
    ENDIF.
  ENDLOOP.
  lv_nextitemoffset = lo_result->get_nextitemoffset( ).
  lv_totalresults = lo_result->get_totalresults( ).
ENDIF.