Message objects contain typed fields that map names to values. More...

Public Member Functions
void	ClearField (String name)
	Clear a field in a message. More...

DateTime	GetDateTime (String fieldName)
	Get the value of a date field from a message. More...

DateTime[]	GetDateTimeArray (String fieldName)
	Get the value of a date array field from a message. More...

Double	GetDouble (String fieldName)
	Get the value of a double field from a message. More...

Double[]	GetDoubleArray (String fieldName)
	Get the value of a double array field from a message. More...

String[]	GetFieldNames ()
	Get the names of all fields present in a message. More...

FieldType	GetFieldType (String fieldName)
	Get the type of a message field. More...

long	GetLong (String fieldName)
	Get the value of a long field from a message. More...

long[]	GetLongArray (String fieldName)
	Get the value of a long array field from a message. More...

IMessage	GetMessage (String fieldName)
	Get the value of a sub-message field from a message. More...

IMessage[]	GetMessageArray (String fieldName)
	Get the value of a message array field from a message. /summary> More...

byte[]	GetOpaque (String fieldName)
	Get the value of an opaque field from a message. More...

String	GetString (String fieldName)
	Get the value of a string field from a message. More...

String[]	GetStringArray (String fieldName)
	Get the value of a string array field from a message. More...

bool	IsFieldSet (String fieldName)
	Determine whether a field is present in the message. More...

void	SetArray (String fieldName, String[] value)
	Set a string array field in a message. More...

void	SetArray (String fieldName, long[] value)

void	SetArray (String fieldName, Double[] value)

void	SetArray (String fieldName, DateTime[] value)
	Set a date array field in a message. More...

void	SetArray (String fieldName, IMessage[] value)
	Set a message array field in a message. More...

void	SetDateTime (String fieldName, DateTime value)
	Set a date field in a message. More...

void	SetDouble (String fieldName, Double value)
	Set a double field in a message. More...

void	SetLong (String fieldName, long value)
	Set a long field in a message. More...

void	SetMessage (String fieldName, IMessage value)
	Set a sub-message field in a message. More...

void	SetOpaque (String fieldName, byte[] value)
	Set an opaque field in a message. More...

void	SetString (String fieldName, String value)
	Set a string field in a message. More...

Properties
long	StoreMessageId `[get]`
	The message's unique store identifier assigned by the persistence service. More...

Detailed Description

Message objects contain typed fields that map names to values.

Member Function Documentation

void TIBCO.EFTL.IMessage.ClearField ( String name )

Clear a field in a message.

Clearing a field clears the data from a field in the message object.

Parameters

name	The method clears the field with this name.

Exceptions

Exception The field does not exist.

DateTime TIBCO.EFTL.IMessage.GetDateTime ( String fieldName )

Get the value of a date field from a message.

Parameters

fieldName Get this field.

Returns: The value of the field, if the field is present and has type FieldType.DATE; null otherwise.

Exceptions

ArgumentException The field name is null or empty.

DateTime [] TIBCO.EFTL.IMessage.GetDateTimeArray ( String fieldName )

Get the value of a date array field from a message.

Parameters

fieldName Get this field.

Returns: The value of the field, if the field is present and has type FieldType.DATE_ARRAY; null otherwise.

Exceptions

ArgumentException The field name is null or empty.

Double TIBCO.EFTL.IMessage.GetDouble ( String fieldName )

Get the value of a double field from a message.

Parameters

fieldName Get this field.

Returns: The value of the field, if the field is present and has type FieldType.DOUBLE; null otherwise.

Exceptions

ArgumentException The field name is null or empty.

Double [] TIBCO.EFTL.IMessage.GetDoubleArray ( String fieldName )

Get the value of a double array field from a message.

Parameters

fieldName Get this field.

Returns: The value of the field, if the field is present and has type FieldType.DOUBLE_ARRAY; null otherwise.

Exceptions

ArgumentException The field name is null or empty.

String [] TIBCO.EFTL.IMessage.GetFieldNames ( )

Get the names of all fields present in a message.

Returns: An array of field names.

FieldType TIBCO.EFTL.IMessage.GetFieldType ( String fieldName )

Get the type of a message field.

Parameters

fieldName The name of the field.

Returns: The type of the field, if present; null otherwise.

Exceptions

ArgumentException If the field name is null or empty.

long TIBCO.EFTL.IMessage.GetLong ( String fieldName )

Get the value of a long field from a message.

Parameters

fieldName Get this field.

Returns: The value of the field, if the field is present and has type FieldType.LONG; null otherwise.

Exceptions

ArgumentException The field name is null or empty.

long [] TIBCO.EFTL.IMessage.GetLongArray ( String fieldName )

Get the value of a long array field from a message.

Parameters

fieldName Get this field.

Returns: The value of the field, if the field is present and has type FieldType.LONG_ARRAY; null otherwise.

Exceptions

ArgumentException The field name is null or empty.

IMessage TIBCO.EFTL.IMessage.GetMessage ( String fieldName )

Get the value of a sub-message field from a message.

Parameters

fieldName Get this field.

Returns

The value of the field, if the field is present and has type FieldType.MESSAGE; null otherwise.

Exceptions

ArgumentException The field name is null or empty.

IMessage [] TIBCO.EFTL.IMessage.GetMessageArray ( String fieldName )

Get the value of a message array field from a message. /summary>

Parameters

fieldName Get this field.

Returns: The value of the field, if the field is present and has

Exceptions

ArgumentException The field name is null or empty.

byte [] TIBCO.EFTL.IMessage.GetOpaque ( String fieldName )

Get the value of an opaque field from a message.

Parameters

fieldName Get this field.

Returns: The value of the field, if the field is present and has type FieldType.OPAQUE; null otherwise.

Exceptions

ArgumentException The field name is null or empty.

String TIBCO.EFTL.IMessage.GetString ( String fieldName )

Get the value of a string field from a message.

Parameters

fieldName Get this field.

Returns: The value of the field, if the field is present and has type FieldType.STRING; null otherwise.

Exceptions

ArgumentException The field name is null or empty.

String [] TIBCO.EFTL.IMessage.GetStringArray ( String fieldName )

Get the value of a string array field from a message.

Parameters

fieldName Get this field.

Returns: The value of the field, if the field is present and has type FieldType.STRING_ARRAY; null otherwise.

Exceptions

ArgumentException The field name is null or empty.

bool TIBCO.EFTL.IMessage.IsFieldSet ( String fieldName )

Determine whether a field is present in the message.

Parameters

fieldName The method checks for this field.

Returns: true if the field is present; false otherwise.

Exceptions

ArgumentException The fieldName argument is null or empty.

void TIBCO.EFTL.IMessage.SetArray	(	String	fieldName,
		String[]	value
	)

Set a string array field in a message.

This method makes an independent copy of the array and strings, and adds the copy to the message. After this method returns you can safely modify the original array and its contents.

Parameters

fieldName	The call sets this field.
value	The call sets this value. (Null is not a legal value within this array.) To remove the field, supply `null`.

Exceptions

ArgumentException The field name is null or empty.

void TIBCO.EFTL.IMessage.SetArray	(	String	fieldName,
		long[]	value
	)

Set a long array field in a message.

This method makes an independent copy of the array, and adds the copy to the message. After this method returns you can safely modify the original array.

Parameters

fieldName	The call sets this field.
value	The call sets this value. To remove the field, supply `null`.

Exceptions

ArgumentException The field name is null or empty.

summary> Set a double array field in a message.

This method makes an independent copy of the array, and adds the copy to the message. After this method returns you can safely modify the original array.

Parameters

fieldName	The call sets this field.
value	The call sets this value. To remove the field, supply `null`.

Exceptions

ArgumentException The field name is null or empty.

void TIBCO.EFTL.IMessage.SetArray	(	String	fieldName,
		Double[]	value
	)

void TIBCO.EFTL.IMessage.SetArray	(	String	fieldName,
		DateTime[]	value
	)

Set a date array field in a message.

This method makes an independent copy of the array, and adds the copy to the message. After this method returns you can safely modify the original array and its contents.

Parameters

fieldName	The call sets this field.
value	The call sets this value. To remove the field, supply `null`.

Exceptions

ArgumentException The field name is null or empty.

void TIBCO.EFTL.IMessage.SetArray	(	String	fieldName,
		IMessage[]	value
	)

Set a message array field in a message.

This method makes an independent copy of the array and messages, and adds the copy to the message. After this method returns you can safely modify the original array and its contents.

Parameters

fieldName	The call sets this field.
value	The call sets this value. To remove the field, supply `null`.

Exceptions

ArgumentException The field name is null or empty.

void TIBCO.EFTL.IMessage.SetDateTime	(	String	fieldName,
		DateTime	value
	)

Set a date field in a message.

Parameters

fieldName	The call sets this field.
value	The call sets this value. To remove the field, supply `null`.

Exceptions

ArgumentException The field name is null or empty.

void TIBCO.EFTL.IMessage.SetDouble	(	String	fieldName,
		Double	value
	)

Set a double field in a message.

Parameters

fieldName	The call sets this field.
value	The call sets this value. To remove the field, supply `null`.

Exceptions

ArgumentException The field name is null or empty.

void TIBCO.EFTL.IMessage.SetLong	(	String	fieldName,
		long	value
	)

Set a long field in a message.

Parameters

fieldName	The call sets this field.
value	The call sets this value.

To remove the field, supply null.

Exceptions

ArgumentException The field name is null or empty.

void TIBCO.EFTL.IMessage.SetMessage	(	String	fieldName,
		IMessage	value
	)

Set a sub-message field in a message.

This method makes an independent copy of the sub-message, and adds the copy to the message. After this method returns you can safely modify the original sub-message.

Parameters

fieldName	The call sets this field.
value	The call sets this value. To remove the field, supply `null`.

Exceptions

ArgumentException The field name is null or empty.

void TIBCO.EFTL.IMessage.SetOpaque	(	String	fieldName,
		byte[]	value
	)

Set an opaque field in a message.

Parameters

fieldName	The call sets this field.
value	The call sets this value. To remove the field, supply `null`

Exceptions

ArgumentException The field name is null or empty.

void TIBCO.EFTL.IMessage.SetString	(	String	fieldName,
		String	value
	)

Set a string field in a message.

Parameters

fieldName	The call sets this field.
value	The call sets this value.

To remove the field, supply null.

Exceptions

ArgumentException The field name is null or empty.

Property Documentation

long TIBCO.EFTL.IMessage.StoreMessageId

get

The message's unique store identifier assigned by the persistence service.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation