IT_Bus::TibrvWSDLArray Class Reference

#include <it_bus_config/tibrv_wsdl_array.h>

Inheritance diagram for IT_Bus::TibrvWSDLArray:

List of all members.

---

Detailed Description

Interface representing the <tibrv:array> child element within the WSDL file for Tibrv extensor elements:.

<tibrv:binding> <tibrv:operation> <tibrv:input> <tibrv:output> <tibrv:msg> <tibrv:field>

Definition at line 31 of file tibrv_wsdl_array.h.

Public Member Functions
virtual void	set_array_element_name (const char *expr)=0
	Indicate the way array element names are encoded on the wire Note, that the developer is responsibe to ensure that the naming expression produces a unqiue name for each array element and that for each array element the expression is evaluated to the same literal on both producer and consumer endpoints.
virtual const String &	get_array_element_name () const=0
	Return array elements name mangling expression.
virtual void	set_integrals_as_single_field (Boolean flag)=0
	Indicate the way an instance of array of integral types is encoded/decoded on/from the wire.
virtual Boolean	get_integrals_as_single_field () const=0
	Return the way an instance of array of integral types is encoded/decoded on/from the wire.
virtual void	set_load_array_size (Boolean flag)=0
	Indicate whether a field that holds array size would be loaded on the wire.
virtual Boolean	get_load_array_size () const=0
	Return whether a field that holds array size is being loaded on the wire.
virtual void	set_array_size_name (const char *expr)=0
	Indicate name expression of the field that would hold arrays size for this binding.
virtual const String &	get_array_size_name () const=0
	Return name mangling expression of the field that will hold arrays size for this binding.

---

Member Function Documentation

virtual void IT_Bus::TibrvWSDLArray::set_array_element_name

(

const char *

expr

)

[pure virtual]

Indicate the way array element names are encoded on the wire Note, that the developer is responsibe to ensure that the naming expression produces a unqiue name for each array element and that for each array element the expression is evaluated to the same literal on both producer and consumer endpoints.

Parameters:

String

with value that confirm to Artix function grammar and may consists of functions: String concat(String arg1, String arg2,..., String argN) Decimal counter(Decimal start, Decimal step) String xml:attr('name')

Tibco Active Enterprise expression = "concat('^', counter(1, 1), '^')";

This will instruct Tibco binding to produce array element names on the wire as follows: "^1^", "^2^", etc.

Default expression = "concat(xml:attr('name'), '_', counter(1, 1))";

This will instruct Tibco binding to produce array element names on the wire as follows: "{value of element's name attribute}_1", "{value of element's name attribute}_2", etc.

virtual const String& IT_Bus::TibrvWSDLArray::get_array_element_name

(

)

const [pure virtual]

Return array elements name mangling expression.

Returns:

String with value that confirm to Artix function grammar and has allowed functions set

virtual void IT_Bus::TibrvWSDLArray::set_integrals_as_single_field

(

Boolean

flag

)

[pure virtual]

Indicate the way an instance of array of integral types is encoded/decoded on/from the wire.

Parameters:

Boolean

with possible values:

IT_true - an instance of array of integral types will be loaded as a single Tibco field with the field name of corresponding WSDL element. That is the value of provided via set_array_element_name() (<tibrv:array elementName>) is ignored IT_false - each element of an instance of array of integral types will be loaded as a separate Tibco field with the field name evaluated based on the value of <tibrv:array elementName> attribute. See set_array_element_name() for more details.

virtual Boolean IT_Bus::TibrvWSDLArray::get_integrals_as_single_field

(

)

const [pure virtual]

Return the way an instance of array of integral types is encoded/decoded on/from the wire.

Returns:

Boolean. See set_integrals_as_single_field() for more details.

virtual void IT_Bus::TibrvWSDLArray::set_load_array_size

(

Boolean

flag

)

[pure virtual]

Indicate whether a field that holds array size would be loaded on the wire.

See set_array_size_name() for details

Parameters:

Boolean

with possible values:

IT_true - field is loaded on the wire IT_false - field is not loaded on the wire

virtual Boolean IT_Bus::TibrvWSDLArray::get_load_array_size

(

)

const [pure virtual]

Return whether a field that holds array size is being loaded on the wire.

See set_array_size_name() for details

Returns:

Boolean with possible values:

IT_true - field is being loaded on the wire IT_false - field is not being loaded on the wire

virtual void IT_Bus::TibrvWSDLArray::set_array_size_name

(

const char *

expr

)

[pure virtual]

Indicate name expression of the field that would hold arrays size for this binding.

This is required when encoding/decoding unbounded arrays with spare nil values.

The following WSDL type may produce such arrays:

<element name="item" type="xsd:string" minoccurs="0" maxoccurs="unbounded" nillable="true">

This field will be stored in the same message as array elements so care needs to be taken to ensure that this name can be uniquely identified within this message.

Parameters:

String

with value that confirm to Artix function grammar and may consists of functions:

• String xml:attr('name')
• String concat(String arg1, String arg2,..., String argN)

Default expression: "concat(xml:attr('name'), '_size')";

This will instruct Tibco binding to produce name for array size field as follows: "item_size"

virtual const String& IT_Bus::TibrvWSDLArray::get_array_size_name

(

)

const [pure virtual]

Return name mangling expression of the field that will hold arrays size for this binding.

Returns:

String with value that confirm to Artix function grammar and has allowed functions set

---