Skip to content

/AWS1/IF_DOA=>UPDATEGOAL()

About UpdateGoal

Update an existing goal

Method Signature

METHODS /AWS1/IF_DOA~UPDATEGOAL
  IMPORTING
    !IV_AGENTSPACEID TYPE /AWS1/DOAAGENTSPACEID OPTIONAL
    !IV_GOALID TYPE /AWS1/DOASTRING OPTIONAL
    !IO_EVALUATIONSCHEDULE TYPE REF TO /AWS1/CL_DOAGOALSCHEDULEINPUT OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/DOASTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_doaupdategoalresponse
  RAISING
    /AWS1/CX_DOAACCESSDENIEDEX
    /AWS1/CX_DOACONFLICTEXCEPTION
    /AWS1/CX_DOACONTENTSIZEEXCDEX
    /AWS1/CX_DOAINTERNALSERVEREX
    /AWS1/CX_DOAINVALIDPARAMETEREX
    /AWS1/CX_DOARESOURCENOTFOUNDEX
    /AWS1/CX_DOASERVICEQUOTAEXCDEX
    /AWS1/CX_DOATHROTTLINGEX
    /AWS1/CX_DOAVLDTNEXCEPTION
    /AWS1/CX_DOACLIENTEXC
    /AWS1/CX_DOASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_agentspaceid TYPE /AWS1/DOAAGENTSPACEID /AWS1/DOAAGENTSPACEID

The unique identifier for the agent space containing the goal

iv_goalid TYPE /AWS1/DOASTRING /AWS1/DOASTRING

The unique identifier of the goal to update

Optional arguments:

io_evaluationschedule TYPE REF TO /AWS1/CL_DOAGOALSCHEDULEINPUT /AWS1/CL_DOAGOALSCHEDULEINPUT

Update goal schedule state

iv_clienttoken TYPE /AWS1/DOASTRING /AWS1/DOASTRING

Client-provided token for idempotent operations

RETURNING

oo_output TYPE REF TO /aws1/cl_doaupdategoalresponse /AWS1/CL_DOAUPDATEGOALRESPONSE

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->updategoal(
  io_evaluationschedule = new /aws1/cl_doagoalscheduleinput( |string| )
  iv_agentspaceid = |string|
  iv_clienttoken = |string|
  iv_goalid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_goal = lo_result->get_goal( ).
  IF lo_goal IS NOT INITIAL.
    lv_string = lo_goal->get_agentspacearn( ).
    lv_string = lo_goal->get_goalid( ).
    lv_string = lo_goal->get_title( ).
    lo_goalcontent = lo_goal->get_content( ).
    IF lo_goalcontent IS NOT INITIAL.
      lv_string = lo_goalcontent->get_description( ).
      lv_string = lo_goalcontent->get_objectives( ).
    ENDIF.
    lv_goalstatus = lo_goal->get_status( ).
    lv_goaltype = lo_goal->get_goaltype( ).
    lv_backlogtimestamp = lo_goal->get_createdat( ).
    lv_backlogtimestamp = lo_goal->get_updatedat( ).
    lv_backlogtimestamp = lo_goal->get_lastevaluatedat( ).
    lv_string = lo_goal->get_lasttaskid( ).
    lv_string = lo_goal->get_lastsuccessfultaskid( ).
    lv_integer = lo_goal->get_version( ).
    lo_goalschedule = lo_goal->get_evaluationschedule( ).
    IF lo_goalschedule IS NOT INITIAL.
      lv_schedulerstate = lo_goalschedule->get_state( ).
      lv_string = lo_goalschedule->get_expression( ).
    ENDIF.
  ENDIF.
ENDIF.