Guida SDK › Open API › Open API Object Classes › Common Global Data Classes › ParameterData Classes › ParameterData

Argomento precedente: ParameterReferenceData

Argomento successivo: Contract Classes
ParameterData

Description

This class is used to represent parameter data.

Members

Name

Type

Description

ParameterName

string

The name of the parameter.

parameterID

long

The ID of the parameter.

ParameterDescription

string

The description of the parameter.

parameterType

ParameterType

An enumeration of the type of the parameter.

ParameterValue

string

The value of the parameter, according to its type:

  • number
  • text
  • date
  • table (represented by legal XML string)
  • list (represented by a string that contains the default value)
  • hyperlink (contains the link’s URL)

ParameterListValues

String[]

Array of strings for the list legal/optional values.

Relevant only if parameter is of type list.

ParameterHyperLinkText

string

The hyperlink text of the parameter.

Relevant only if parameter is of type hyperlink.

ParameterValidation

string

Optional. The validation of the parameter.

Relevant only if parameter is of type number. It is an XML string representing the number’s minimum, maximum, and decimal precision restrictions. The parameter’s value must conform to these restrictions.

RefParamData

ParameterReferenceData

The parameter reference data.

ParameterOrder

long

The order parameter.

Remarks

The field "ParameterOrder" dates from version 7.0 SP1.

An example of data in a properly formatted, legal XML type table is given below:

<Table>
<TableStructure>
<Col Name="Kunde" Index="Y" Mandatory="N" Type="Text" />
<Col Name="Anteil_in_Prozent" Index="N" Mandatory="N" Type="Number" />
</TableStructure>


<TableElements />
</Table>

XML_TABLE_STRUCTURE