javax.microedition.ipdr.configuration
Interface TemplateConfig

public interface TemplateConfig

This interface provides a configuration of a Templat ETA defines that at least one implementation must be implemented by the ETA implementer. The required implementation takes all the information from the JAD/manifest

Version:

1.0

Author:

Shai Gotlib

Method Summary

FieldConfig	getFieldById(int id) Returns the configuration of the field acording to its id.
FieldConfig	getFieldConfigAt(int position) Returns the configuration of the field acording to its position.
java.util.Enumeration	getFieldList() Returns the list of FieldConfig.
int	getFieldListLength() Returns the length of the field list.
java.lang.String	getSchemaName() Returns the schema name.
java.lang.String	getTemplateDescription() Returns the template description.
short	getTemplateId() Returns the template id.
java.lang.String	getTypeName() Returns the type name - the complex type defined in the schema and associates with this temaplte.
void	setFields(java.util.Enumeration fields) Sets the Fields
void	setId(short id) Sets the Template id
void	setSchemaName(java.lang.String schemaName) Sets the schema name
void	setTemplateDescription(java.lang.String templateDescription) Sets the template description
void	setTypeName(java.lang.String typeName) Sets the type name.
void	validateSelf() Validates the configuration the Templat

Method Detail

getFieldById

public FieldConfig getFieldById(int id)

Returns the configuration of the field acording to its id.

Parameters:

id - field id

Returns:

FieldConfig by its id

See Also:

FieldConfig

getFieldConfigAt

public FieldConfig getFieldConfigAt(int position)

Returns the configuration of the field acording to its position.

Parameters:

position - the field position

Returns:

FieldConfig according to its position

See Also:

FieldConfig, FieldConfig

getFieldList

public java.util.Enumeration getFieldList()

Returns the list of FieldConfig.

Returns:

Enumeration - list of FieldConfig

See Also:

FieldConfig

getFieldListLength

public int getFieldListLength()

Returns the length of the field list.

Returns:

the length of the field list (int)

getSchemaName

public java.lang.String getSchemaName()

Returns the schema name.

Returns:

the schema name (String)

getTemplateDescription

public java.lang.String getTemplateDescription()

Returns the template description.

Returns:

the template description (String)

getTemplateId

public short getTemplateId()

Returns the template id.

Returns:

the template id (short)

getTypeName

public java.lang.String getTypeName()

Returns the type name - the complex type defined in the schema and associates with this temaplte.

Returns:

the type name (String)

See Also:

getSchemaName()

setFields

public void setFields(java.util.Enumeration fields)

Sets the Fields

Returns:

void

See Also:

FieldConfig

setId

public void setId(short id)

Sets the Template id

Parameters:

id - Template id

Returns:

void

setSchemaName

public void setSchemaName(java.lang.String schemaName)

Sets the schema name

Parameters:

schemaName - the schema name

Returns:

void

setTemplateDescription

public void setTemplateDescription(java.lang.String templateDescription)

Sets the template description

Parameters:

templateDescription - schema template description

Returns:

void

setTypeName

public void setTypeName(java.lang.String typeName)

Sets the type name. The type name is the name of the type as defined in the relevant schema and associate with this template.

Parameters:

typeName - type name

Returns:

void

validateSelf

public void validateSelf()
                  throws ConfigException

Validates the configuration the Templat

Returns:

void

Throws:

ConfigException

See Also:

ConfigException