raccoon.api.eai.message
Interface IField

All Known Implementing Classes:

RvField

public interface IField

An element of an EAI Message.

Since:

Raccoon v1.0

Version:

$Id: IField.java,v 1.1 2004/08/08 20:25:56 crouvrais Exp $

Author:

Cedric ROUVRAIS

Field Summary

static java.lang.String	FIELD_DATA_NOT_NULL Error message indication a non null field data is compulsory.
static java.lang.String	FIELD_NAME_NOT_NULL Error message indication a non null field name is compulsory.

Method Summary

java.lang.Object	getData() Retrieves the data associated to this field instance.
int	getId() Retrieves the id of this field.
java.lang.String	getName() Retrieves the name of this field.
int	getType() Returns the type of the object.
void	setData(java.lang.Object pData) Defines the data associated to this field instance.
void	setId(int pId) Defines the id of this field.
void	setName(java.lang.String pFieldName) Defines the name of this field.
void	setType(int pType) Defines the type of the object.

Field Detail

FIELD_NAME_NOT_NULL

static final java.lang.String FIELD_NAME_NOT_NULL

Error message indication a non null field name is compulsory.

See Also:

Constant Field Values

FIELD_DATA_NOT_NULL

static final java.lang.String FIELD_DATA_NOT_NULL

Error message indication a non null field data is compulsory.

See Also:

Constant Field Values

Method Detail

setName

void setName(java.lang.String pFieldName)
             throws java.lang.IllegalArgumentException

Defines the name of this field.

Parameters:

pFieldName - the name of this field

Throws:

java.lang.IllegalArgumentException - if pFieldName is null

getName

java.lang.String getName()

Retrieves the name of this field.

Returns:

the name of this field

setData

void setData(java.lang.Object pData)
             throws java.lang.IllegalArgumentException

Defines the data associated to this field instance.

Parameters:

pData - the payload of this field.

Throws:

java.lang.IllegalArgumentException - if pData is null

getData

java.lang.Object getData()

Retrieves the data associated to this field instance.

Returns:

the payload of this field

setId

void setId(int pId)
           throws java.lang.IllegalArgumentException

Defines the id of this field. Default value should be 0, meaning that this field isn't indexed.

Parameters:

pId - the id of this field, should be unique per message if different from zero.

Throws:

java.lang.IllegalArgumentException - if the ID is invalid.

getId

int getId()

Retrieves the id of this field.

Returns:

the id of this field

setType

void setType(int pType)
             throws java.lang.IllegalArgumentException

Defines the type of the object.

Parameters:

pType - the object type.

Throws:

java.lang.IllegalArgumentException - if the type is invalid.

getType

int getType()

Returns the type of the object.

Returns:

the object type