FunctionParameterDefinition

Name FunctionParameterDefinition
Usage FunctionRepositoryService
FunctionDefinition
Type Complex

Description

An immutable representation of a function parameter definition.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
id Id String The unique identifier for an object. This can be null.     One No  
name Name String Returns the name of this parameters. All parameters have a name and this
value can never be null or blank. The parameter name must be unique
within a given function definition.
Required   One No  
description Description String Returns the description of this parameter. The description is intended
to provide more information about a parameter and it's appropriate
usage. The description is optional and will be null if a
description is not defined.
    One No  
parameterType Parameter Type String Returns the type of this function parameter. This can be one of a set
of "built-in" data types or a custom data type represented as a fully
qualified java class name. All parameters must have a valid type so
this method should never return null or blank.
Required   One No  
sequenceNumber Sequence Number Integer This is the sequence number of the function parameter.
The sequence number identifies the position of the
parameter in the function list.
Required   One No  
functionId Function Id String Returns the ID of the function to which this parameter is associated. Required   One No  
versionNumber Version Number Long Returns the version number for this object. In general, this value should only
be null if the object has not yet been stored to a persistent data store.
This version number is generally used for the purposes of optimistic locking.
    One No