Skip to content

/AWS1/IF_SCG=>LISTTAGOPTIONS()

About ListTagOptions

Lists the specified TagOptions or all TagOptions.

Method Signature

METHODS /AWS1/IF_SCG~LISTTAGOPTIONS
  IMPORTING
    !IO_FILTERS TYPE REF TO /AWS1/CL_SCGLISTTAGOPTSFILTERS OPTIONAL
    !IV_PAGESIZE TYPE /AWS1/SCGPAGESIZE OPTIONAL
    !IV_PAGETOKEN TYPE /AWS1/SCGPAGETOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_scglisttagoptsoutput
  RAISING
    /AWS1/CX_SCGINVALIDPARAMSEX
    /AWS1/CX_SCGTAGOPTIONNOTMIGR00
    /AWS1/CX_SCGCLIENTEXC
    /AWS1/CX_SCGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

io_filters TYPE REF TO /AWS1/CL_SCGLISTTAGOPTSFILTERS /AWS1/CL_SCGLISTTAGOPTSFILTERS

The search filters. If no search filters are specified, the output includes all TagOptions.

iv_pagesize TYPE /AWS1/SCGPAGESIZE /AWS1/SCGPAGESIZE

The maximum number of items to return with this call.

iv_pagetoken TYPE /AWS1/SCGPAGETOKEN /AWS1/SCGPAGETOKEN

The page token for the next set of results. To retrieve the first set of results, use null.

RETURNING

oo_output TYPE REF TO /aws1/cl_scglisttagoptsoutput /AWS1/CL_SCGLISTTAGOPTSOUTPUT

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->listtagoptions(
  io_filters = new /aws1/cl_scglisttagoptsfilters(
    iv_active = ABAP_TRUE
    iv_key = |string|
    iv_value = |string|
  )
  iv_pagesize = 123
  iv_pagetoken = |string|
).

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_tagoptiondetails( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_tagoptionkey = lo_row_1->get_key( ).
      lv_tagoptionvalue = lo_row_1->get_value( ).
      lv_tagoptionactive = lo_row_1->get_active( ).
      lv_tagoptionid = lo_row_1->get_id( ).
      lv_owner = lo_row_1->get_owner( ).
    ENDIF.
  ENDLOOP.
  lv_pagetoken = lo_result->get_pagetoken( ).
ENDIF.