Adaptive Framework  0.9.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Variables

Adaptive Function to_string<password> More...

Variables

 afw_function_definition_abs
 Function definition abs.
 
 afw_function_definition_add
 Adaptive Function abs More...
 
 afw_function_definition_add_dayTimeDuration
 Adaptive Function add More...
 
 afw_function_definition_add_yearMonthDuration
 Adaptive Function add_dayTimeDuration More...
 
 afw_function_definition_at_least_one_member_of
 Adaptive Function add_yearMonthDuration More...
 
 afw_function_definition_bag
 Adaptive Function at_least_one_member_of More...
 
 afw_function_definition_bag_size
 Adaptive Function bag More...
 
 afw_function_definition_ceil
 Adaptive Function bag_size More...
 
 afw_function_definition_clone
 Adaptive Function ceil More...
 
 afw_function_definition_compile
 Adaptive Function clone More...
 
 afw_function_definition_decode_to_string
 Adaptive Function compile More...
 
 afw_function_definition_divide
 Adaptive Function decode_to_string More...
 
 afw_function_definition_encode_as_base64Binary
 Adaptive Function divide More...
 
 afw_function_definition_encode_as_hexBinary
 Adaptive Function encode_as_base64Binary More...
 
 afw_function_definition_ends_with
 Adaptive Function encode_as_hexBinary More...
 
 afw_function_definition_eq
 Adaptive Function ends_with More...
 
 afw_function_definition_eq_ignore_case
 Adaptive Function eq More...
 
 afw_function_definition_eqx
 Adaptive Function eq_ignore_case More...
 
 afw_function_definition_evaluate
 Adaptive Function eqx More...
 
 afw_function_definition_floor
 Adaptive Function evaluate More...
 
 afw_function_definition_ge
 Adaptive Function floor More...
 
 afw_function_definition_gt
 Adaptive Function ge More...
 
 afw_function_definition_in_range
 Adaptive Function gt More...
 
 afw_function_definition_includes
 Adaptive Function in_range More...
 
 afw_function_definition_index_of
 Adaptive Function includes More...
 
 afw_function_definition_intersection
 Adaptive Function index_of More...
 
 afw_function_definition_is
 Adaptive Function intersection More...
 
 afw_function_definition_is_in
 Adaptive Function is More...
 
 afw_function_definition_last_index_of
 Adaptive Function is_in More...
 
 afw_function_definition_le
 Adaptive Function last_index_of More...
 
 afw_function_definition_length
 Adaptive Function le More...
 
 afw_function_definition_lt
 Adaptive Function length More...
 
 afw_function_definition_match
 Adaptive Function lt More...
 
 afw_function_definition_max
 Adaptive Function match More...
 
 afw_function_definition_min
 Adaptive Function max More...
 
 afw_function_definition_mod
 Adaptive Function min More...
 
 afw_function_definition_multiply
 Adaptive Function mod More...
 
 afw_function_definition_ne
 Adaptive Function multiply More...
 
 afw_function_definition_negative
 Adaptive Function ne More...
 
 afw_function_definition_nex
 Adaptive Function negative More...
 
 afw_function_definition_normalize_space
 Adaptive Function nex More...
 
 afw_function_definition_normalize_to_lower_case
 Adaptive Function normalize_space More...
 
 afw_function_definition_one_and_only
 Adaptive Function normalize_to_lower_case More...
 
 afw_function_definition_pow
 Adaptive Function one_and_only More...
 
 afw_function_definition_regexp_index_of
 Adaptive Function pow More...
 
 afw_function_definition_regexp_match
 Adaptive Function regexp_index_of More...
 
 afw_function_definition_regexp_replace
 Adaptive Function regexp_match More...
 
 afw_function_definition_repeat
 Adaptive Function regexp_replace More...
 
 afw_function_definition_replace
 Adaptive Function repeat More...
 
 afw_function_definition_round
 Adaptive Function replace More...
 
 afw_function_definition_set_equals
 Adaptive Function round More...
 
 afw_function_definition_split
 Adaptive Function set_equals More...
 
 afw_function_definition_starts_with
 Adaptive Function split More...
 
 afw_function_definition_subset
 Adaptive Function starts_with More...
 
 afw_function_definition_substring
 Adaptive Function subset More...
 
 afw_function_definition_subtract
 Adaptive Function substring More...
 
 afw_function_definition_subtract_dayTimeDuration
 Adaptive Function subtract More...
 
 afw_function_definition_subtract_yearMonthDuration
 Adaptive Function subtract_dayTimeDuration More...
 
 afw_function_definition_to_anyURI
 Adaptive Function subtract_yearMonthDuration More...
 
 afw_function_definition_to_boolean
 Adaptive Function to_anyURI More...
 
 afw_function_definition_to_date
 Adaptive Function to_boolean More...
 
 afw_function_definition_to_dateTime
 Adaptive Function to_date More...
 
 afw_function_definition_to_dayTimeDuration
 Adaptive Function to_dateTime More...
 
 afw_function_definition_to_dnsName
 Adaptive Function to_dayTimeDuration More...
 
 afw_function_definition_to_double
 Adaptive Function to_dnsName More...
 
 afw_function_definition_to_integer
 Adaptive Function to_double More...
 
 afw_function_definition_to_ipAddress
 Adaptive Function to_integer More...
 
 afw_function_definition_to_rfc822Name
 Adaptive Function to_ipAddress More...
 
 afw_function_definition_to_string
 Adaptive Function to_rfc822Name More...
 
 afw_function_definition_to_time
 Adaptive Function to_string More...
 
 afw_function_definition_to_x500Name
 Adaptive Function to_time More...
 
 afw_function_definition_to_yearMonthDuration
 Adaptive Function to_x500Name More...
 
 afw_function_definition_union
 Adaptive Function to_yearMonthDuration More...
 
 afw_function_definition_url_encode
 Adaptive Function union More...
 

Detailed Description

Adaptive Function to_string<password>

Parameters
xfunction execute parameter.

Converts password value to string. For list values, the to_string() value for each entry is returned separated with commas.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_string<password>(
value: password
): string;

Parameters:

value - (password) A password value.

Returns:

(string) The string representation of the value.

Implemented by afw_function_execute_convert()


polymorphic adaptive functions.

Variable Documentation

◆ afw_function_definition_add

afw_function_definition_add

Adaptive Function abs

Parameters
xfunction execute parameter.

Compute the absolute value of the <dataType> value and return the <dataType> result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

double, integer.

Declaration:

function abs <dataType>(
value: dataType
): dataType;

Parameters:

value - (<Type>)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition add

Definition at line 20569 of file afw_function_bindings.h.

◆ afw_function_definition_add_dayTimeDuration

afw_function_definition_add_dayTimeDuration

Adaptive Function add

Parameters
xfunction execute parameter.

Add 2 or more <dataType> values and return the <dataType> result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

double, integer, string.

Declaration:

function add <dataType>(
values_1: dataType,
values_2: dataType,
...values_rest: (list of dataType)
): dataType;

Parameters:

values - (2 or more <Type>)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition add_dayTimeDuration

Definition at line 20609 of file afw_function_bindings.h.

◆ afw_function_definition_add_yearMonthDuration

afw_function_definition_add_yearMonthDuration

Adaptive Function add_dayTimeDuration

Parameters
xfunction execute parameter.

Add <dataType> arg1 to dayTimeDuration arg2 and return the <dataType> result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

dateTime.

Declaration:

function add_dayTimeDuration <dataType>(
arg1: dataType,
arg2: dayTimeDuration
): dataType;

Parameters:

arg1 - (<Type>)

arg2 - (dayTimeDuration)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition add_yearMonthDuration

Definition at line 20651 of file afw_function_bindings.h.

◆ afw_function_definition_at_least_one_member_of

afw_function_definition_at_least_one_member_of

Adaptive Function add_yearMonthDuration

Parameters
xfunction execute parameter.

Add <dataType> arg1 to yearMonthDuration arg2 and return the <dataType> result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

date, dateTime.

Declaration:

function add_yearMonthDuration <dataType>(
arg1: dataType,
arg2: yearMonthDuration
): dataType;

Parameters:

arg1 - (<Type>)

arg2 - (yearMonthDuration)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition at_least_one_member_of

Definition at line 20693 of file afw_function_bindings.h.

◆ afw_function_definition_bag

afw_function_definition_bag

Adaptive Function at_least_one_member_of

Parameters
xfunction execute parameter.

Returns boolean true if at least one value in <dataType> list1 is in <dataType> list2.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, double, hexBinary, integer, rfc822Name, string, time, x500Name, yearMonthDuration.

Declaration:

function at_least_one_member_of <dataType>(
list1: list,
list2: list
): boolean;

Parameters:

list1 - (list <Type>) The first list.

list2 - (list <Type>) The second list.

Returns:

(boolean)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition bag

Definition at line 20736 of file afw_function_bindings.h.

◆ afw_function_definition_bag_size

afw_function_definition_bag_size

Adaptive Function bag

Parameters
xfunction execute parameter.

Takes any number of <dataType> values and returns a list of list.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, dnsName, double, expression, function, hexBinary, hybrid, ia5String, integer, ipAddress, list, null, object, objectId, objectPath, password, rfc822Name, script, string, template, time, x500Name, xpathExpression, yearMonthDuration.

Declaration:

function bag <dataType>(
...values: (list of list)
): list;

Parameters:

values - (0 or more list <Type>)

Returns:

(list <Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition bag_size

Definition at line 20778 of file afw_function_bindings.h.

◆ afw_function_definition_ceil

afw_function_definition_ceil

Adaptive Function bag_size

Parameters
xfunction execute parameter.

This returns the integer number of values in list.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, dnsName, double, expression, function, hexBinary, hybrid, ia5String, integer, ipAddress, list, null, object, objectId, objectPath, password, rfc822Name, script, string, template, time, x500Name, xpathExpression, yearMonthDuration.

Declaration:

function bag_size <dataType>(
value: list
): integer;

Parameters:

value - (list <Type>)

Returns:

(integer)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition ceil

Definition at line 20820 of file afw_function_bindings.h.

◆ afw_function_definition_clone

afw_function_definition_clone

Adaptive Function ceil

Parameters
xfunction execute parameter.

Determine the smallest integer that is greater then or equal to the <dataType> value and return the <dataType> result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

double.

Declaration:

function ceil <dataType>(
value: dataType
): dataType;

Parameters:

value - (<Type>)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition clone

Definition at line 20859 of file afw_function_bindings.h.

◆ afw_function_definition_compile

afw_function_definition_compile

Adaptive Function clone

Parameters
xfunction execute parameter.

Deep clone a <dataType> value.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

list, object.

Declaration:

function clone <dataType>(
value: dataType
): dataType;

Parameters:

value - (<Type>) The <dataType> value to clone.

Returns:

(<Type>) The cloned <dataType> value.

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition compile

Definition at line 20897 of file afw_function_bindings.h.

◆ afw_function_definition_decode_to_string

afw_function_definition_decode_to_string

Adaptive Function compile

Parameters
xfunction execute parameter.

Compile <dataType> value and return either an unevaluated adaptive value or a string containing the compiler listing.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

expression, hybrid, regexp, script, template, xpathExpression.

Declaration:

function compile <dataType>(
source: dataType,
listing?: any
): unevaluated;

Parameters:

source - (<Type>) <dataType> string to compile.

listing - (optional any dataType) If specified, a compiler listing is produced instead of an unevaluated expression value.

This parameter can be an integer between 0 and 10 of a string that is used for indentation. If 0 is specified, no whitespace is added to the resulting string. If 1 through 10 is specified, that number of spaces is used.

Returns:

(unevaluated)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition decode_to_string

Definition at line 20945 of file afw_function_bindings.h.

◆ afw_function_definition_divide

afw_function_definition_divide

Adaptive Function decode_to_string

Parameters
xfunction execute parameter.

Decode <dataType> value to string. An error is thrown if decoded value is not valid UTF-8.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

base64Binary, hexBinary.

Declaration:

function decode_to_string <dataType>(
value: dataType
): string;

Parameters:

value - (<Type>) The <dataType> value to decode.

Returns:

(string) The decoded string.

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition divide

Definition at line 20984 of file afw_function_bindings.h.

◆ afw_function_definition_encode_as_base64Binary

afw_function_definition_encode_as_base64Binary

Adaptive Function divide

Parameters
xfunction execute parameter.

Divide <dataType> dividend by <dataType> divisor and return the <dataType> quotient.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

double, integer.

Declaration:

function divide <dataType>(
dividend: dataType,
divisor: dataType
): dataType;

Parameters:

dividend - (<Type>)

divisor - (<Type>)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition encode_as_base64Binary

Definition at line 21026 of file afw_function_bindings.h.

◆ afw_function_definition_encode_as_hexBinary

afw_function_definition_encode_as_hexBinary

Adaptive Function encode_as_base64Binary

Parameters
xfunction execute parameter.

Encode a value as a base64Binary. The effect is to create a base64Binary value with an internal value of the value passed.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

string.

Declaration:

function encode_as_base64Binary <dataType>(
value: dataType
): base64Binary;

Parameters:

value - (<Type>) The <dataType> value to encode.

Returns:

(base64Binary) A base64Binary value.

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition encode_as_hexBinary

Definition at line 21065 of file afw_function_bindings.h.

◆ afw_function_definition_ends_with

afw_function_definition_ends_with

Adaptive Function encode_as_hexBinary

Parameters
xfunction execute parameter.

Encode a value as a hexBinary. The effect is to create a hexBinary value with an internal value of the value passed.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

string.

Declaration:

function encode_as_hexBinary <dataType>(
value: dataType
): hexBinary;

Parameters:

value - (<Type>) The <dataType> value to encode.

Returns:

(hexBinary) A hexBinary value.

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition ends_with

Definition at line 21104 of file afw_function_bindings.h.

◆ afw_function_definition_eq

afw_function_definition_eq

Adaptive Function ends_with

Parameters
xfunction execute parameter.

Checks whether <dataType> value ends with a <dataType> and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, string.

Declaration:

function ends_with <dataType>(
value: dataType,
subString: string
): boolean;

Parameters:

value - (<Type>)

subString - (string)

Returns:

(boolean)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition eq

Definition at line 21146 of file afw_function_bindings.h.

◆ afw_function_definition_eq_ignore_case

afw_function_definition_eq_ignore_case

Adaptive Function eq

Parameters
xfunction execute parameter.

Determine if <dataType> arg1 is equal to the value of arg2 converted to the data type of arg1 then return the boolean result. Use "eqx" ("===") instead if you want false to be returned if arg1 and arg2's data type don't match.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, dnsName, double, expression, function, hexBinary, hybrid, ia5String, integer, ipAddress, list, object, objectId, objectPath, password, regexp, rfc822Name, script, string, template, time, x500Name, xpathExpression, yearMonthDuration.

Declaration:

function eq <dataType>(
arg1: dataType,
arg2: any
): boolean;

Parameters:

arg1 - (<Type>)

arg2 - (any dataType)

Returns:

(boolean)

Errors thrown:

conversion - arg2 cannot be converted to the data type of arg1.

Implemented by afw_function_execute_eq()


Function definition eq_ignore_case

Definition at line 21198 of file afw_function_bindings.h.

◆ afw_function_definition_eqx

afw_function_definition_eqx

Adaptive Function eq_ignore_case

Parameters
xfunction execute parameter.

Checks for <dataType> arg1 is equal to <dataType> arg2 ignoring case and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

string.

Declaration:

function eq_ignore_case <dataType>(
arg1: dataType,
arg2: dataType
): boolean;

Parameters:

arg1 - (<Type>)

arg2 - (<Type>)

Returns:

(boolean)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition eqx

Definition at line 21240 of file afw_function_bindings.h.

◆ afw_function_definition_evaluate

afw_function_definition_evaluate

Adaptive Function eqx

Parameters
xfunction execute parameter.

Determine if for <dataType> arg1 is equal to the value and data type of arg2 then return the boolean result. Use "eq" ("==") instead if you want arg2 to be converted to the data type of arg1 before comparison.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, dnsName, double, expression, function, hexBinary, hybrid, ia5String, integer, ipAddress, list, object, objectId, objectPath, password, regexp, rfc822Name, script, string, template, time, x500Name, xpathExpression, yearMonthDuration.

Declaration:

function eqx <dataType>(
arg1: dataType,
arg2: any
): boolean;

Parameters:

arg1 - (<Type>)

arg2 - (any dataType)

Returns:

(boolean)

Implemented by afw_function_execute_eqx()


Function definition evaluate

Definition at line 21287 of file afw_function_bindings.h.

◆ afw_function_definition_floor

afw_function_definition_floor

Adaptive Function evaluate

Parameters
xfunction execute parameter.

Compile and evaluate <dataType> value.

This function is not pure, so it may return a different result given exactly the same parameters.

Supported <dataType>:

expression, hybrid, script, template, xpathExpression.

Declaration:

function evaluate <dataType>(
source: dataType,
additionalUntrustedQualifiedVariables?: (object _AdaptiveHybridPropertiesObjects_)
): unevaluated;

Parameters:

source - (<Type>) <dataType> string to compile and evaluate.

additionalUntrustedQualifiedVariables - (optional object AdaptiveHybridPropertiesObjects) This parameter supplies additional qualified variables that can be accessed during evaluation. These variables will not be used by anything that needs to ensure its qualified variables must come from a trusted source, such as authorization. This parameter is intended to be used for testing only and should not be used for anything running in production.

Returns:

(unevaluated)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition floor

Definition at line 21334 of file afw_function_bindings.h.

◆ afw_function_definition_ge

afw_function_definition_ge

Adaptive Function floor

Parameters
xfunction execute parameter.

Determine the largest integer that is smaller then or equal to the <dataType> value and return the <dataType> result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

double.

Declaration:

function floor <dataType>(
number: dataType
): dataType;

Parameters:

number - (<Type>)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition ge

Definition at line 21373 of file afw_function_bindings.h.

◆ afw_function_definition_gt

afw_function_definition_gt

Adaptive Function ge

Parameters
xfunction execute parameter.

Checks for <dataType> arg1 is greater than or equal to <dataType> arg2 and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, dnsName, double, expression, function, hexBinary, hybrid, ia5String, integer, ipAddress, list, object, objectId, objectPath, password, regexp, rfc822Name, script, string, template, time, x500Name, xpathExpression, yearMonthDuration.

Declaration:

function ge <dataType>(
arg1: dataType,
arg2: dataType
): boolean;

Parameters:

arg1 - (<Type>)

arg2 - (<Type>)

Returns:

(boolean)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition gt

Definition at line 21419 of file afw_function_bindings.h.

◆ afw_function_definition_in_range

afw_function_definition_in_range

Adaptive Function gt

Parameters
xfunction execute parameter.

Checks for <dataType> arg1 is greater than <dataType> arg2 and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, dnsName, double, expression, function, hexBinary, hybrid, ia5String, integer, ipAddress, list, object, objectId, objectPath, password, regexp, rfc822Name, script, string, template, time, x500Name, xpathExpression, yearMonthDuration.

Declaration:

function gt <dataType>(
arg1: dataType,
arg2: dataType
): boolean;

Parameters:

arg1 - (<Type>)

arg2 - (<Type>)

Returns:

(boolean)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition in_range

Definition at line 21465 of file afw_function_bindings.h.

◆ afw_function_definition_includes

afw_function_definition_includes

Adaptive Function in_range

Parameters
xfunction execute parameter.

Checks if <dataType> is between startTime and endTime, inclusive. Regardless of endTime value, it is always considered to be equal to, but less than 24 hours greater than startTime. If no <dataType> zone is specified for <dataType>, the default <dataType> zone is used. If no <dataType> zone is specified for startTime or endTime, the <dataType> zone of <dataType> is used.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

time.

Declaration:

function in_range <dataType>(
time: dataType,
startTime: dataType,
endTime: dataType
): boolean;

Parameters:

time - (<Type>)

startTime - (<Type>)

endTime - (<Type>)

Returns:

(boolean)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition includes

Definition at line 21514 of file afw_function_bindings.h.

◆ afw_function_definition_index_of

afw_function_definition_index_of

Adaptive Function includes

Parameters
xfunction execute parameter.

Checks whether the <dataType> value includes a string and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, list, string.

Declaration:

function includes <dataType>(
searchString: dataType,
subString: string,
position?: integer
): boolean;

Parameters:

searchString - (<Type>) The <dataType> to search.

subString - (string) Substring to find.

position - (optional integer) Zero-based position in the search string to start search.

Returns:

(boolean) Indicates if the substring is contained in the search string.

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition index_of

Definition at line 21560 of file afw_function_bindings.h.

◆ afw_function_definition_intersection

afw_function_definition_intersection

Adaptive Function index_of

Parameters
xfunction execute parameter.

Returns the zero-based index into <dataType> value of subString. If subString is not found, -1 is returned.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, string.

Declaration:

function index_of <dataType>(
value: dataType,
subString: string,
startIndex?: integer
): integer;

Parameters:

value - (<Type>) The <dataType> value to search.

subString - (string) Substring to search for.

startIndex - (optional integer) Optional start index for search if different than start of string.

Returns:

(integer) Zero-based index of subString or -1 if not found.

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition intersection

Definition at line 21606 of file afw_function_bindings.h.

◆ afw_function_definition_is

afw_function_definition_is

Adaptive Function intersection

Parameters
xfunction execute parameter.

Returns a list of <dataType> with the values that are common to both list of <dataType> list1 and list2.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, double, hexBinary, integer, rfc822Name, string, time, x500Name, yearMonthDuration.

Declaration:

function intersection <dataType>(
list1: list,
list2: list
): list;

Parameters:

list1 - (list <Type>) The first list.

list2 - (list <Type>) The second list.

Returns:

(list <Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition is

Definition at line 21649 of file afw_function_bindings.h.

◆ afw_function_definition_is_in

afw_function_definition_is_in

Adaptive Function is

Parameters
xfunction execute parameter.

Checks whether value is dataType <dataType> and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, dnsName, double, expression, function, hexBinary, hybrid, ia5String, integer, ipAddress, list, null, object, objectId, objectPath, password, rfc822Name, script, string, template, time, x500Name, xpathExpression, yearMonthDuration, unevaluated.

Declaration:

function is <dataType>(
value: any
): boolean;

Parameters:

value - (any dataType) Value to check.

Returns:

(boolean)

Implemented by afw_function_execute_is()


Function definition is_in

Definition at line 21691 of file afw_function_bindings.h.

◆ afw_function_definition_last_index_of

afw_function_definition_last_index_of

Adaptive Function is_in

Parameters
xfunction execute parameter.

Checks whether <dataType> value is in list of <dataType> list and returns the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, dnsName, double, hexBinary, integer, ipAddress, rfc822Name, string, time, x500Name, yearMonthDuration.

Declaration:

function is_in <dataType>(
value: dataType,
list: list
): boolean;

Parameters:

value - (<Type>)

list - (list <Type>)

Returns:

(boolean)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition last_index_of

Definition at line 21735 of file afw_function_bindings.h.

◆ afw_function_definition_le

afw_function_definition_le

Adaptive Function last_index_of

Parameters
xfunction execute parameter.

Returns the zero-based index into <dataType> value of the last occurrence of a subString. If subString is not found, -1 is returned.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, string.

Declaration:

function last_index_of <dataType>(
value: dataType,
subString: string,
startIndex?: integer
): integer;

Parameters:

value - (<Type>) The <dataType> value to search.

subString - (string) Substring to search for.

startIndex - (optional integer) Optional start index for search if different than start of string.

Returns:

(integer) Zero-based index of subString or -1 if not found.

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition le

Definition at line 21781 of file afw_function_bindings.h.

◆ afw_function_definition_length

afw_function_definition_length

Adaptive Function le

Parameters
xfunction execute parameter.

Checks for <dataType> arg1 is less than or equal to <dataType> arg2 and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, dnsName, double, expression, function, hexBinary, hybrid, ia5String, integer, ipAddress, list, object, objectId, objectPath, password, regexp, rfc822Name, script, string, template, time, x500Name, xpathExpression, yearMonthDuration.

Declaration:

function le <dataType>(
arg1: dataType,
arg2: any
): boolean;

Parameters:

arg1 - (<Type>)

arg2 - (any dataType)

Returns:

(boolean)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition length

Definition at line 21827 of file afw_function_bindings.h.

◆ afw_function_definition_lt

afw_function_definition_lt

Adaptive Function length

Parameters
xfunction execute parameter.

This is a polymorphic function where <dataType> can be any of the supported data types. Return the integer number of entries in datatype list or codepoints in others.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, list, string.

Declaration:

function length <dataType>(
value: dataType
): integer;

Parameters:

value - (<Type>) Returns the number of entries in a list or code points in others.

Returns:

(integer)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition lt

Definition at line 21868 of file afw_function_bindings.h.

◆ afw_function_definition_match

afw_function_definition_match

Adaptive Function lt

Parameters
xfunction execute parameter.

Checks for <dataType> arg1 is less that <dataType> arg2 and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, dnsName, double, expression, function, hexBinary, hybrid, ia5String, integer, ipAddress, list, object, objectId, objectPath, password, regexp, rfc822Name, script, string, template, time, x500Name, xpathExpression, yearMonthDuration.

Declaration:

function lt <dataType>(
arg1: dataType,
arg2: dataType
): boolean;

Parameters:

arg1 - (<Type>)

arg2 - (<Type>)

Returns:

(boolean)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition match

Definition at line 21914 of file afw_function_bindings.h.

◆ afw_function_definition_max

afw_function_definition_max

Adaptive Function match

Parameters
xfunction execute parameter.

Returns true if arg1 matches some terminal sequence of RDNs from arg2 when compared using equal_<dataType>.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

rfc822Name, x500Name.

Declaration:

function match <dataType>(
arg1: dataType,
arg2: string
): boolean;

Parameters:

arg1 - (<Type>)

arg2 - (string)

Returns:

(boolean)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition max

Definition at line 21956 of file afw_function_bindings.h.

◆ afw_function_definition_min

afw_function_definition_min

Adaptive Function max

Parameters
xfunction execute parameter.

Return the <dataType> value that is greater than or equal to the others.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

date, dateTime, double, integer, string, time.

Declaration:

function max <dataType>(
values_1: dataType,
...values_rest: (list of dataType)
): dataType;

Parameters:

values - (1 or more <Type>)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition min

Definition at line 21995 of file afw_function_bindings.h.

◆ afw_function_definition_mod

afw_function_definition_mod

Adaptive Function min

Parameters
xfunction execute parameter.

Return the <dataType> value that is less than or equal to the others.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

date, dateTime, double, integer, string, time.

Declaration:

function min <dataType>(
values_1: dataType,
...values_rest: (list of dataType)
): dataType;

Parameters:

values - (1 or more <Type>)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition mod

Definition at line 22034 of file afw_function_bindings.h.

◆ afw_function_definition_multiply

afw_function_definition_multiply

Adaptive Function mod

Parameters
xfunction execute parameter.

Divide <dataType> dividend by <dataType> divisor and return the <dataType> remainder.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

integer.

Declaration:

function mod <dataType>(
dividend: dataType,
divisor: dataType
): dataType;

Parameters:

dividend - (<Type>)

divisor - (<Type>)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition multiply

Definition at line 22076 of file afw_function_bindings.h.

◆ afw_function_definition_ne

afw_function_definition_ne

Adaptive Function multiply

Parameters
xfunction execute parameter.

Multiply 2 or more <dataType> values and return the <dataType> result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

double, integer.

Declaration:

function multiply <dataType>(
values_1: dataType,
values_2: dataType,
...values_rest: (list of dataType)
): dataType;

Parameters:

values - (2 or more <Type>)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition ne

Definition at line 22116 of file afw_function_bindings.h.

◆ afw_function_definition_negative

afw_function_definition_negative

Adaptive Function ne

Parameters
xfunction execute parameter.

Determine if <dataType> arg1 is not equal to the value of arg2 converted to the data type of arg1 then return the boolean result. Use "nex" ("!==") instead if you want true to be returned if arg1 and arg2's data type don't match.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, dnsName, double, expression, function, hexBinary, hybrid, ia5String, integer, ipAddress, list, object, objectId, objectPath, password, regexp, rfc822Name, script, string, template, time, x500Name, xpathExpression, yearMonthDuration.

Declaration:

function ne <dataType>(
arg1: dataType,
arg2: any
): boolean;

Parameters:

arg1 - (<Type>)

arg2 - (any dataType)

Returns:

(boolean)

Errors thrown:

conversion - arg2 cannot be converted to the data type of arg1.

Implemented by afw_function_execute_ne()


Function definition negative

Definition at line 22168 of file afw_function_bindings.h.

◆ afw_function_definition_nex

afw_function_definition_nex

Adaptive Function negative

Parameters
xfunction execute parameter.

Return negative of <dataType> value.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

double, integer.

Declaration:

function negative <dataType>(
value: dataType
): dataType;

Parameters:

value - (<Type>)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition nex

Definition at line 22206 of file afw_function_bindings.h.

◆ afw_function_definition_normalize_space

afw_function_definition_normalize_space

Adaptive Function nex

Parameters
xfunction execute parameter.

Determine if for <dataType> arg1 is not equal to the value or data type of arg2 then return the boolean result. Use "ne" ("!=") instead if you want arg2 to be converted to the data type of arg1 before comparison.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, dnsName, double, expression, function, hexBinary, hybrid, ia5String, integer, ipAddress, list, object, objectId, objectPath, password, rfc822Name, regexp, script, string, template, time, x500Name, xpathExpression, yearMonthDuration.

Declaration:

function nex <dataType>(
arg1: dataType,
arg2: any
): boolean;

Parameters:

arg1 - (<Type>)

arg2 - (any dataType)

Returns:

(boolean)

Implemented by afw_function_execute_nex()


Function definition normalize_space

Definition at line 22253 of file afw_function_bindings.h.

◆ afw_function_definition_normalize_to_lower_case

afw_function_definition_normalize_to_lower_case

Adaptive Function normalize_space

Parameters
xfunction execute parameter.

Remove whitespace from the beginning and end of a <dataType> value.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

string.

Declaration:

function normalize_space <dataType>(
string: dataType
): dataType;

Parameters:

string - (<Type>)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition normalize_to_lower_case

Definition at line 22291 of file afw_function_bindings.h.

◆ afw_function_definition_one_and_only

afw_function_definition_one_and_only

Adaptive Function normalize_to_lower_case

Parameters
xfunction execute parameter.

Normalize <dataType> value to lower case and returns <dataType> result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

string.

Declaration:

function normalize_to_lower_case <dataType>(
string: dataType
): dataType;

Parameters:

string - (<Type>)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition one_and_only

Definition at line 22329 of file afw_function_bindings.h.

◆ afw_function_definition_pow

afw_function_definition_pow

Adaptive Function one_and_only

Parameters
xfunction execute parameter.

This converts a list of <dataType> values that contains one value to a single <dataType> value.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, dnsName, double, hexBinary, integer, ipAddress, rfc822Name, string, time, x500Name, yearMonthDuration.

Declaration:

function one_and_only <dataType>(
list: (list list)
): dataType;

Parameters:

list - (list list)

Returns:

(<Type>)

Errors thrown:

arg_error - list does not contain exactly one value

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition pow

Definition at line 22374 of file afw_function_bindings.h.

◆ afw_function_definition_regexp_index_of

afw_function_definition_regexp_index_of

Adaptive Function pow

Parameters
xfunction execute parameter.

This returns the value of base raised to a power. Multiple exponents can be specified to raise the previous exponent to the power of the latter exponent.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

double.

Declaration:

function pow <dataType>(
base: dataType,
exponent_1: dataType,
...exponent_rest: (list of dataType)
): dataType;

Parameters:

base - (<Type>) Base value.

exponent - (1 or more <Type>) Exponent value.

Returns:

(<Type>) Base raised to the power.

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition regexp_index_of

Definition at line 22418 of file afw_function_bindings.h.

◆ afw_function_definition_regexp_match

afw_function_definition_regexp_match

Adaptive Function regexp_index_of

Parameters
xfunction execute parameter.

Search <dataType> value for a regular expression and return index. If not found, -1 is returned.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, string.

Declaration:

function regexp_index_of <dataType>(
value: dataType,
regexp: string
): integer;

Parameters:

value - (<Type>) The <dataType> value to search.

regexp - (string) A regular expression to use for search.

Returns:

(integer) Zero-based index of subString or -1 if not found.

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition regexp_match

Definition at line 22460 of file afw_function_bindings.h.

◆ afw_function_definition_regexp_replace

afw_function_definition_regexp_replace

Adaptive Function regexp_match

Parameters
xfunction execute parameter.

Checks whether <dataType> value matches the regular expression regexp and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, dnsName, ipAddress, rfc822Name, string, x500Name.

Declaration:

function regexp_match <dataType>(
value: dataType,
regexp: string
): boolean;

Parameters:

value - (<Type>)

regexp - (string)

Returns:

(boolean)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition regexp_replace

Definition at line 22502 of file afw_function_bindings.h.

◆ afw_function_definition_repeat

afw_function_definition_repeat

Adaptive Function regexp_replace

Parameters
xfunction execute parameter.

Replace matched values for a regular expression in a <dataType> value.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, string.

Declaration:

function regexp_replace <dataType>(
value: dataType,
regexp: string,
replacement: string,
limit?: integer
): dataType;

Parameters:

value - (<Type>) The original <dataType> value.

regexp - (string) A regular expression to use for search.

replacement - (string) The replacement string.

limit - (optional integer) This is the maximum times to replace. The default is 1. Specify -1 to replace all occurrences.

Returns:

(<Type>) A <dataType> value with the matched string(s) replaced.

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition repeat

Definition at line 22550 of file afw_function_bindings.h.

◆ afw_function_definition_replace

afw_function_definition_replace

Adaptive Function repeat

Parameters
xfunction execute parameter.

Repeat a <dataType> value a specified number of times.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, string.

Declaration:

function repeat <dataType>(
value: dataType,
times: integer
): dataType;

Parameters:

value - (<Type>) The <dataType> value to repeat.

times - (integer) The number of times to repeat the value.

Returns:

(<Type>) The repeated <dataType> value.

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition replace

Definition at line 22591 of file afw_function_bindings.h.

◆ afw_function_definition_round

afw_function_definition_round

Adaptive Function replace

Parameters
xfunction execute parameter.

Replace string(s) in a <dataType> value.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, string.

Declaration:

function replace <dataType>(
value: dataType,
match: string,
replacement: string,
limit?: integer
): dataType;

Parameters:

value - (<Type>) The original <dataType> value.

match - (string) The string to replace.

replacement - (string) The replacement string.

limit - (optional integer) This is the maximum times to replace. The default is 1. Specify -1 to replace all occurrences.

Returns:

(<Type>) A <dataType> value with the matched string(s) replaced.

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition round

Definition at line 22639 of file afw_function_bindings.h.

◆ afw_function_definition_set_equals

afw_function_definition_set_equals

Adaptive Function round

Parameters
xfunction execute parameter.

Determine the integer closest to <dataType> value and return the <dataType> result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

double.

Declaration:

function round <dataType>(
number: dataType
): dataType;

Parameters:

number - (<Type>)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition set_equals

Definition at line 22678 of file afw_function_bindings.h.

◆ afw_function_definition_split

afw_function_definition_split

Adaptive Function set_equals

Parameters
xfunction execute parameter.

Returns boolean true if <dataType> list1 and <dataType> list2 are subsets of each other and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, double, hexBinary, integer, rfc822Name, string, time, x500Name, yearMonthDuration.

Declaration:

function set_equals <dataType>(
list1: list,
list2: list
): boolean;

Parameters:

list1 - (list <Type>)

list2 - (list <Type>)

Returns:

(boolean)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition split

Definition at line 22721 of file afw_function_bindings.h.

◆ afw_function_definition_starts_with

afw_function_definition_starts_with

Adaptive Function split

Parameters
xfunction execute parameter.

Split <dataType> value into an list of strings using a separator.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, string.

Declaration:

function split <dataType>(
value: dataType,
separator?: string,
limit?: integer
): list;

Parameters:

value - (<Type>) The <dataType> value to split.

separator - (optional string) The separator to use. If this is an empty string or separator is not specified, the value is split between characters.

limit - (optional integer) This is the maximum number of splits. Any remaining part of value is ignored.

Returns:

(list) An list of strings.

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition starts_with

Definition at line 22768 of file afw_function_bindings.h.

◆ afw_function_definition_subset

afw_function_definition_subset

Adaptive Function starts_with

Parameters
xfunction execute parameter.

Checks whether <dataType> value starts with a subString and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, string.

Declaration:

function starts_with <dataType>(
value: dataType,
subString: string
): boolean;

Parameters:

value - (<Type>)

subString - (string)

Returns:

(boolean)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition subset

Definition at line 22810 of file afw_function_bindings.h.

◆ afw_function_definition_substring

afw_function_definition_substring

Adaptive Function subset

Parameters
xfunction execute parameter.

Returns boolean true if the unique values in <dataType> list1 are all in <dataType> list2.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, double, hexBinary, integer, rfc822Name, string, time, x500Name, yearMonthDuration.

Declaration:

function subset <dataType>(
list1: list,
list2: list
): boolean;

Parameters:

list1 - (list <Type>) The first list.

list2 - (list <Type>) The second list.

Returns:

(boolean)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition substring

Definition at line 22853 of file afw_function_bindings.h.

◆ afw_function_definition_subtract

afw_function_definition_subtract

Adaptive Function substring

Parameters
xfunction execute parameter.

Returns the <dataType> substring of value beginning at zero-based position integer startIndex and ending at the position before integer endIndex. Specify -1 or omitting endIndex to return up to end of <dataType>.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, string.

Declaration:

function substring <dataType>(
string: dataType,
startIndex: integer,
endIndex?: integer
): dataType;

Parameters:

string - (<Type>)

startIndex - (integer)

endIndex - (optional integer)

Returns:

(<Type>)

Errors thrown:

arg_error - startIndex or endIndex is out of range

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition subtract

Definition at line 22903 of file afw_function_bindings.h.

◆ afw_function_definition_subtract_dayTimeDuration

afw_function_definition_subtract_dayTimeDuration

Adaptive Function subtract

Parameters
xfunction execute parameter.

Subtract <dataType> arg2 from <dataType> arg1 and return the <dataType> result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

double, integer.

Declaration:

function subtract <dataType>(
arg1: dataType,
arg2: dataType
): dataType;

Parameters:

arg1 - (<Type>)

arg2 - (<Type>)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition subtract_dayTimeDuration

Definition at line 22945 of file afw_function_bindings.h.

◆ afw_function_definition_subtract_yearMonthDuration

afw_function_definition_subtract_yearMonthDuration

Adaptive Function subtract_dayTimeDuration

Parameters
xfunction execute parameter.

Subtract dayTimeDuration arg2 from <dataType> arg1 and return the <dataType> result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

dateTime.

Declaration:

function subtract_dayTimeDuration <dataType>(
arg1: dataType,
arg2: dayTimeDuration
): dataType;

Parameters:

arg1 - (<Type>)

arg2 - (dayTimeDuration)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition subtract_yearMonthDuration

Definition at line 22987 of file afw_function_bindings.h.

◆ afw_function_definition_to_anyURI

afw_function_definition_to_anyURI

Adaptive Function subtract_yearMonthDuration

Parameters
xfunction execute parameter.

Subtract yearMonthDuration arg2 from <dataType> arg1 and return the <dataType> result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

date, dateTime.

Declaration:

function subtract_yearMonthDuration <dataType>(
arg1: dataType,
arg2: yearMonthDuration
): dataType;

Parameters:

arg1 - (<Type>)

arg2 - (yearMonthDuration)

Returns:

(<Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition to_anyURI

Definition at line 23029 of file afw_function_bindings.h.

◆ afw_function_definition_to_boolean

afw_function_definition_to_boolean

Adaptive Function to_anyURI

Parameters
xfunction execute parameter.

Converts <dataType> value to anyURI.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

string.

Declaration:

function to_anyURI <dataType>(
value: dataType
): anyURI;

Parameters:

value - (<Type>)

Returns:

(anyURI)

Errors thrown:

cast_error - value could not be converted

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition to_boolean

Definition at line 23071 of file afw_function_bindings.h.

◆ afw_function_definition_to_date

afw_function_definition_to_date

Adaptive Function to_boolean

Parameters
xfunction execute parameter.

Converts <dataType> value to boolean.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

string.

Declaration:

function to_boolean <dataType>(
value: dataType
): boolean;

Parameters:

value - (<Type>)

Returns:

(boolean)

Errors thrown:

cast_error - value could not be converted

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition to_date

Definition at line 23113 of file afw_function_bindings.h.

◆ afw_function_definition_to_dateTime

afw_function_definition_to_dateTime

Adaptive Function to_date

Parameters
xfunction execute parameter.

Converts <dataType> value to date.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

string.

Declaration:

function to_date <dataType>(
value: dataType
): date;

Parameters:

value - (<Type>)

Returns:

(date)

Errors thrown:

cast_error - value could not be converted

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition to_dateTime

Definition at line 23155 of file afw_function_bindings.h.

◆ afw_function_definition_to_dayTimeDuration

afw_function_definition_to_dayTimeDuration

Adaptive Function to_dateTime

Parameters
xfunction execute parameter.

Converts <dataType> value to dateTime.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

string.

Declaration:

function to_dateTime <dataType>(
value: dataType
): dateTime;

Parameters:

value - (<Type>)

Returns:

(dateTime)

Errors thrown:

cast_error - value could not be converted

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition to_dayTimeDuration

Definition at line 23197 of file afw_function_bindings.h.

◆ afw_function_definition_to_dnsName

afw_function_definition_to_dnsName

Adaptive Function to_dayTimeDuration

Parameters
xfunction execute parameter.

Converts <dataType> value to dayTimeDuration.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

string.

Declaration:

function to_dayTimeDuration <dataType>(
value: dataType
): dayTimeDuration;

Parameters:

value - (<Type>)

Returns:

(dayTimeDuration)

Errors thrown:

cast_error - value could not be converted

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition to_dnsName

Definition at line 23239 of file afw_function_bindings.h.

◆ afw_function_definition_to_double

afw_function_definition_to_double

Adaptive Function to_dnsName

Parameters
xfunction execute parameter.

Converts <dataType> value to dnsName.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

string.

Declaration:

function to_dnsName <dataType>(
value: dataType
): dnsName;

Parameters:

value - (<Type>)

Returns:

(dnsName)

Errors thrown:

cast_error - value could not be converted

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition to_double

Definition at line 23281 of file afw_function_bindings.h.

◆ afw_function_definition_to_integer

afw_function_definition_to_integer

Adaptive Function to_double

Parameters
xfunction execute parameter.

Converts <dataType> value to double and returns double result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

integer, string.

Declaration:

function to_double <dataType>(
value: dataType
): double;

Parameters:

value - (<Type>)

Returns:

(double)

Errors thrown:

cast_error - value could not be converted

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition to_integer

Definition at line 23323 of file afw_function_bindings.h.

◆ afw_function_definition_to_ipAddress

afw_function_definition_to_ipAddress

Adaptive Function to_integer

Parameters
xfunction execute parameter.

Truncate <dataType> value to a whole number and returns integer result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

double, string.

Declaration:

function to_integer <dataType>(
value: dataType
): integer;

Parameters:

value - (<Type>)

Returns:

(integer)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition to_ipAddress

Definition at line 23361 of file afw_function_bindings.h.

◆ afw_function_definition_to_rfc822Name

afw_function_definition_to_rfc822Name

Adaptive Function to_ipAddress

Parameters
xfunction execute parameter.

Converts <dataType> value to ipAddress.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

string.

Declaration:

function to_ipAddress <dataType>(
value: dataType
): ipAddress;

Parameters:

value - (<Type>)

Returns:

(ipAddress)

Errors thrown:

cast_error - value could not be converted

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition to_rfc822Name

Definition at line 23403 of file afw_function_bindings.h.

◆ afw_function_definition_to_string

afw_function_definition_to_string

Adaptive Function to_rfc822Name

Parameters
xfunction execute parameter.

Converts <dataType> value to rfc822Name.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

string.

Declaration:

function to_rfc822Name <dataType>(
value: dataType
): rfc822Name;

Parameters:

value - (<Type>)

Returns:

(rfc822Name)

Errors thrown:

cast_error - value could not be converted

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition to_string

Definition at line 23445 of file afw_function_bindings.h.

◆ afw_function_definition_to_time

afw_function_definition_to_time

Adaptive Function to_string

Parameters
xfunction execute parameter.

Converts <dataType> value to string. For list values, the to_string() value for each entry is returned separated with commas.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, dnsName, double, expression, hexBinary, hybrid, ia5String, integer, ipAddress, list, null, object, objectId, objectPath, password, rfc822Name, string, template, time, x500Name, xpathExpression, yearMonthDuration.

Declaration:

function to_string <dataType>(
value: dataType
): string;

Parameters:

value - (<Type>) A <dataType> value.

Returns:

(string) The string representation of the value.

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition to_time

Definition at line 23487 of file afw_function_bindings.h.

◆ afw_function_definition_to_x500Name

afw_function_definition_to_x500Name

Adaptive Function to_time

Parameters
xfunction execute parameter.

Converts <dataType> value to time.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

string.

Declaration:

function to_time <dataType>(
value: dataType
): time;

Parameters:

value - (<Type>)

Returns:

(time)

Errors thrown:

cast_error - value could not be converted

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition to_x500Name

Definition at line 23529 of file afw_function_bindings.h.

◆ afw_function_definition_to_yearMonthDuration

afw_function_definition_to_yearMonthDuration

Adaptive Function to_x500Name

Parameters
xfunction execute parameter.

Converts <dataType> value to x500Name.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

string.

Declaration:

function to_x500Name <dataType>(
value: dataType
): x500Name;

Parameters:

value - (<Type>)

Returns:

(x500Name)

Errors thrown:

cast_error - value could not be converted

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition to_yearMonthDuration

Definition at line 23571 of file afw_function_bindings.h.

◆ afw_function_definition_union

afw_function_definition_union

Adaptive Function to_yearMonthDuration

Parameters
xfunction execute parameter.

Converts <dataType> value to yearMonthDuration.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

string.

Declaration:

function to_yearMonthDuration <dataType>(
value: dataType
): yearMonthDuration;

Parameters:

value - (<Type>)

Returns:

(yearMonthDuration)

Errors thrown:

cast_error - value could not be converted

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition union

Definition at line 23613 of file afw_function_bindings.h.

◆ afw_function_definition_url_encode

afw_function_definition_url_encode

Adaptive Function union

Parameters
xfunction execute parameter.

Returns a list of <dataType> contains all of the unique values in two or more list of <dataType> values.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Supported <dataType>:

anyURI, base64Binary, boolean, date, dateTime, dayTimeDuration, double, hexBinary, integer, rfc822Name, string, time, x500Name, yearMonthDuration.

Declaration:

function union <dataType>(
lists_1: list,
lists_2: list,
...lists_rest: (list of list)
): list;

Parameters:

lists - (2 or more list <Type>) Two or more lists.

Returns:

(list <Type>)

Implemented by AFW_FUNCTION_EXECUTE_STANDARD_POLYMORPHIC_FUNCTION_HANDLING()


Function definition url_encode

Definition at line 23655 of file afw_function_bindings.h.