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

Adaptive Function to_string<ia5String> More...

Functions

const afw_value_tafw_function_execute_index_create (afw_function_execute_t *x)
 Adaptive Function index_create More...
 
const afw_value_tafw_function_execute_index_list (afw_function_execute_t *x)
 Adaptive Function index_list More...
 
const afw_value_tafw_function_execute_index_remove (afw_function_execute_t *x)
 Adaptive Function index_remove More...
 

Variables

 afw_function_definition_index_create
 Function definition index_create.
 
 afw_function_definition_index_list
 Function definition index_list.
 
 afw_function_definition_index_remove
 Function definition index_remove.
 

Detailed Description

Adaptive Function to_string<ia5String>

Parameters
xfunction execute parameter.

Converts ia5String 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<ia5String>(
value: ia5String
): string;

Parameters:

value - (ia5String) A ia5String value.

Returns:

(string) The string representation of the value.

Implemented by afw_function_execute_convert()


indexes adaptive functions.

Function Documentation

◆ afw_function_execute_index_create()

const afw_value_t* afw_function_execute_index_create ( afw_function_execute_t x)

Adaptive Function index_create

Parameters
xfunction execute parameter.

Create an index definition.

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

Declaration:

function index_create(
adaptorId: string,
key: string,
value?: string,
objectType?: string,
filter?: string,
options?: string,
retroactive?: boolean,
test?: boolean
): object;

Parameters:

adaptorId - (string) Id of adaptor.

key - (string) Name of the property index to be created.

value - (optional string) Expression to calculate the index value(s).

objectType - (optional string) Object Type(s) this index may apply to.

filter - (optional string) Expression to determine if this index applies to a particular object.

options - (optional string) Indexing options.

retroactive - (optional boolean) Retroactively generate indexes for existing objects.

test - (optional boolean) Test create (don't actually perform).

Returns:

(object) Object response from the indexing process.

Definition at line 70 of file afw_function_indexes.c.

◆ afw_function_execute_index_list()

const afw_value_t* afw_function_execute_index_list ( afw_function_execute_t x)

Adaptive Function index_list

Parameters
xfunction execute parameter.

List property indexes

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

Declaration:

function index_list(
adaptorId: string,
objectType?: string
): object;

Parameters:

adaptorId - (string) Id of adaptor.

objectType - (optional string) Id of adaptive object type indexes.

Returns:

(object) Object response from the index repair process.

Definition at line 184 of file afw_function_indexes.c.

◆ afw_function_execute_index_remove()

const afw_value_t* afw_function_execute_index_remove ( afw_function_execute_t x)

Adaptive Function index_remove

Parameters
xfunction execute parameter.

Remove an index definition.

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

Declaration:

function index_remove(
adaptorId: string,
key: string
): object;

Parameters:

adaptorId - (string) Id of adaptor.

key - (string) The index key to be removed.

Returns:

(object) Object response from the indexing process.

Definition at line 238 of file afw_function_indexes.c.