/AWS1/IF_SGM=>UPDATETRIALCOMPONENT()

About UpdateTrialComponent

Updates one or more properties of a trial component.

Method Signature

METHODS /AWS1/IF_SGM~UPDATETRIALCOMPONENT
  IMPORTING
    !IV_TRIALCOMPONENTNAME TYPE /AWS1/SGMEXPERIMENTENTITYNAME OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/SGMEXPERIMENTENTITYNAME OPTIONAL
    !IO_STATUS TYPE REF TO /AWS1/CL_SGMTRIALCOMPONENTSTAT OPTIONAL
    !IV_STARTTIME TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_ENDTIME TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IT_PARAMETERS TYPE /AWS1/CL_SGMTRIALCOMPONENTPR00=>TT_TRIALCOMPONENTPARAMETERS OPTIONAL
    !IT_PARAMETERSTOREMOVE TYPE /AWS1/CL_SGMLSTTRIALCOMPONEN02=>TT_LISTTRIALCOMPONENTKEY256 OPTIONAL
    !IT_INPUTARTIFACTS TYPE /AWS1/CL_SGMTRIALCOMPONENTAR00=>TT_TRIALCOMPONENTARTIFACTS OPTIONAL
    !IT_INPUTARTIFACTSTOREMOVE TYPE /AWS1/CL_SGMLSTTRIALCOMPONEN02=>TT_LISTTRIALCOMPONENTKEY256 OPTIONAL
    !IT_OUTPUTARTIFACTS TYPE /AWS1/CL_SGMTRIALCOMPONENTAR00=>TT_TRIALCOMPONENTARTIFACTS OPTIONAL
    !IT_OUTPUTARTIFACTSTOREMOVE TYPE /AWS1/CL_SGMLSTTRIALCOMPONEN02=>TT_LISTTRIALCOMPONENTKEY256 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmuptrialcomponent01
  RAISING
    /AWS1/CX_SGMCONFLICTEXCEPTION
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_trialcomponentname TYPE /AWS1/SGMEXPERIMENTENTITYNAME /AWS1/SGMEXPERIMENTENTITYNAME

The name of the component to update.

Optional arguments:

iv_displayname TYPE /AWS1/SGMEXPERIMENTENTITYNAME /AWS1/SGMEXPERIMENTENTITYNAME

The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

io_status TYPE REF TO /AWS1/CL_SGMTRIALCOMPONENTSTAT /AWS1/CL_SGMTRIALCOMPONENTSTAT

The new status of the component.

iv_starttime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

When the component started.

iv_endtime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

When the component ended.

it_parameters TYPE /AWS1/CL_SGMTRIALCOMPONENTPR00=>TT_TRIALCOMPONENTPARAMETERS TT_TRIALCOMPONENTPARAMETERS

Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.

it_parameterstoremove TYPE /AWS1/CL_SGMLSTTRIALCOMPONEN02=>TT_LISTTRIALCOMPONENTKEY256 TT_LISTTRIALCOMPONENTKEY256

The hyperparameters to remove from the component.

it_inputartifacts TYPE /AWS1/CL_SGMTRIALCOMPONENTAR00=>TT_TRIALCOMPONENTARTIFACTS TT_TRIALCOMPONENTARTIFACTS

Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.

it_inputartifactstoremove TYPE /AWS1/CL_SGMLSTTRIALCOMPONEN02=>TT_LISTTRIALCOMPONENTKEY256 TT_LISTTRIALCOMPONENTKEY256

The input artifacts to remove from the component.

it_outputartifacts TYPE /AWS1/CL_SGMTRIALCOMPONENTAR00=>TT_TRIALCOMPONENTARTIFACTS TT_TRIALCOMPONENTARTIFACTS

Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.

it_outputartifactstoremove TYPE /AWS1/CL_SGMLSTTRIALCOMPONEN02=>TT_LISTTRIALCOMPONENTKEY256 TT_LISTTRIALCOMPONENTKEY256

The output artifacts to remove from the component.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmuptrialcomponent01 /AWS1/CL_SGMUPTRIALCOMPONENT01

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->updatetrialcomponent(
  io_status = new /aws1/cl_sgmtrialcomponentstat(
    iv_message = |string|
    iv_primarystatus = |string|
  )
  it_inputartifacts = VALUE /aws1/cl_sgmtrialcomponentar00=>tt_trialcomponentartifacts(
    (
      VALUE /aws1/cl_sgmtrialcomponentar00=>ts_trialcomponentarti00_maprow(
        value = new /aws1/cl_sgmtrialcomponentar00(
          iv_mediatype = |string|
          iv_value = |string|
        )
        key = |string|
      )
    )
  )
  it_inputartifactstoremove = VALUE /aws1/cl_sgmlsttrialcomponen02=>tt_listtrialcomponentkey256(
    ( new /aws1/cl_sgmlsttrialcomponen02( |string| ) )
  )
  it_outputartifacts = VALUE /aws1/cl_sgmtrialcomponentar00=>tt_trialcomponentartifacts(
    (
      VALUE /aws1/cl_sgmtrialcomponentar00=>ts_trialcomponentarti00_maprow(
        value = new /aws1/cl_sgmtrialcomponentar00(
          iv_mediatype = |string|
          iv_value = |string|
        )
        key = |string|
      )
    )
  )
  it_outputartifactstoremove = VALUE /aws1/cl_sgmlsttrialcomponen02=>tt_listtrialcomponentkey256(
    ( new /aws1/cl_sgmlsttrialcomponen02( |string| ) )
  )
  it_parameters = VALUE /aws1/cl_sgmtrialcomponentpr00=>tt_trialcomponentparameters(
    (
      VALUE /aws1/cl_sgmtrialcomponentpr00=>ts_trialcomponentparams_maprow(
        key = |string|
        value = new /aws1/cl_sgmtrialcomponentpr00(
          iv_numbervalue = '0.1'
          iv_stringvalue = |string|
        )
      )
    )
  )
  it_parameterstoremove = VALUE /aws1/cl_sgmlsttrialcomponen02=>tt_listtrialcomponentkey256(
    ( new /aws1/cl_sgmlsttrialcomponen02( |string| ) )
  )
  iv_displayname = |string|
  iv_endtime = '20150101000000.0000000'
  iv_starttime = '20150101000000.0000000'
  iv_trialcomponentname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_trialcomponentarn = lo_result->get_trialcomponentarn( ).
ENDIF.