Skip to content

/AWS1/CL_BDAPARAMETERDETAIL

Contains details about a parameter in a function for an action group.

This data type is used in the following API operations:

CONSTRUCTOR

IMPORTING

Required arguments:

iv_type TYPE /AWS1/BDATYPE /AWS1/BDATYPE

The data type of the parameter.

Optional arguments:

iv_description TYPE /AWS1/BDAPARAMETERDESCRIPTION /AWS1/BDAPARAMETERDESCRIPTION

A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

iv_required TYPE /AWS1/BDABOOLEAN /AWS1/BDABOOLEAN

Whether the parameter is required for the agent to complete the function for action group invocation.


Queryable Attributes

description

A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

Accessible with the following methods

Method Description
GET_DESCRIPTION() Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION() Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION() Determine if DESCRIPTION has a value

type

The data type of the parameter.

Accessible with the following methods

Method Description
GET_TYPE() Getter for TYPE, with configurable default
ASK_TYPE() Getter for TYPE w/ exceptions if field has no value
HAS_TYPE() Determine if TYPE has a value

required

Whether the parameter is required for the agent to complete the function for action group invocation.

Accessible with the following methods

Method Description
GET_REQUIRED() Getter for REQUIRED, with configurable default
ASK_REQUIRED() Getter for REQUIRED w/ exceptions if field has no value
HAS_REQUIRED() Determine if REQUIRED has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TS_PARAMETERMAP_MAPROW

TYPES: BEGIN OF TS_PARAMETERMAP_MAPROW,
  key TYPE /AWS1/BDANAME,
  value TYPE REF TO /AWS1/CL_BDAPARAMETERDETAIL,
END OF TS_PARAMETERMAP_MAPROW.

TT_PARAMETERMAP

TYPES TT_PARAMETERMAP TYPE HASHED TABLE OF /AWS1/CL_BDAPARAMETERDETAIL=>TS_PARAMETERMAP_MAPROW WITH UNIQUE KEY key
.