com.bea.tuxedo.control
Interface ITuxField

All Known Implementing Classes:

TuxFieldFMLSerialize, TuxFieldViewSerialize

public interface ITuxField

Interface representing a single field in a Tuxedo view or FML buffer. The field may be accessed via a JavaBean style setter/getter or via the FML add, get interfaces.

Method Summary

String	getName() Get the name of the field.
int	getSize(Object obj) Get the current number of occurrences or the size of max size of the array.
int	getType() Get the Tuxedo type of the field.
Object	getValue(Object object) Get the value of the field.
void	setValue(Object object, Object value) Sets the value of the field.

Method Detail

getName

String getName()

Get the name of the field.

Returns:

A string representing the field name. If the field is represented by a setter or getter, this is the name stripped of the set, get, or is prefix.

getType

int getType()

Get the Tuxedo type of the field.

Returns:

An integer representing the Tuxedo type code of the field.

setValue

void setValue(Object object,
              Object value)
              throws ControlException

Sets the value of the field. For fields that are arrays or have multiple occurrences, sets the next available array index or occurrence.

Parameters:

object - The class object for the defining class.

value - The value to set.

Throws:

ControlException

getValue

Object getValue(Object object)
                throws ControlException

Get the value of the field. For fields that are array types or that have multiple occurrences, returns the next value to be accessed.

Parameters:

object - The class object for the defining class.

Returns:

The value of the field.

Throws:

ControlException

getSize

int getSize(Object obj)

Get the current number of occurrences or the size of max size of the array.

Parameters:

obj - The buffer object

Returns:

The current number of occurrences or max array size.