org.openeai.config
Class Field

java.lang.Object
  org.openeai.config.Field

public class Field
extends java.lang.Object

This object represents a single field in the EnterpriseObjects documents. It wraps the information found in that document for a given field in to a Java object. These objects are then stored in the EnterpriseFields java object and are used to apply various business rules to values being set on specific instance variables within an organization's Message Object API. This is accomplished through the EnterpriseFormatter object which contains, Scrubbers, Translators etc.

Version:

3.0 - 28 January 2003

Author:

Tod Jackson (tod@openeai.org), Steve Wheat (steve@openeai.org)

See Also:

EnterpriseFields, EnterpriseFormatter

Constructor Summary

Field()
Constructor

Method Summary

java.lang.String	getFieldName() Returns the name of the field.
EnterpriseFormatter	getFormatter() Returns the EnterpriseFormatter associated to this Field.
java.lang.String	getParentObjectName() Returns the name of the Field's parent object.
boolean	isKey() Returns a flag indicating if this field is part of the parent object's key information.
boolean	isRequired() Convenience method that uses the EnterpriseFormatter associated to this field to determine if this Field is a required field.
void	setFieldName(java.lang.String name) Sets the name of the field.
void	setFormatter(EnterpriseFormatter formatter) Sets the EnterpriseFormatter associated to this Field.
void	setIsKey(boolean isKey) Sets the flag that indicates if this field is a part of the parent object's key information.
void	setParentObjectName(java.lang.String name) Sets the name of the Field's parent object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Field

public Field()

Constructor

Method Detail

isKey

public boolean isKey()

Returns a flag indicating if this field is part of the parent object's key information.

Returns:

boolean true=the field is a part of the key, false=the key is not a part of the key

setIsKey

public void setIsKey(boolean isKey)

Sets the flag that indicates if this field is a part of the parent object's key information. This is called as the EnterpriseFields object constructs these Field objects as they're found in the EnterpriseObjects XML Documents.

Parameters:

isKey - boolean true=the field is a part of the key, false=the key is not a part of the key

setFieldName

public void setFieldName(java.lang.String name)

Sets the name of the field. This information is retrieved from the EnterpriseObjects XML Document as the EnterpriseField object builds itself with information found in that document.

Parameters:

name - String the name of the field as specified in the EnterpriseObjects XML Document.

getFieldName

public java.lang.String getFieldName()

Returns the name of the field.

Returns:

String the field's name.

setParentObjectName

public void setParentObjectName(java.lang.String name)

Sets the name of the Field's parent object. For example, the Gender field is a child of the BasicPerson object.

Parameters:

name - String the name of the parent object as specified in the EnterpriseObjects XML documents.

getParentObjectName

public java.lang.String getParentObjectName()

Returns the name of the Field's parent object.

Returns:

String the parent object's name.

getFormatter

public EnterpriseFormatter getFormatter()

Returns the EnterpriseFormatter associated to this Field.

Returns:

EnterpriseFormatter

See Also:

EnterpriseFormatter

setFormatter

public void setFormatter(EnterpriseFormatter formatter)

Sets the EnterpriseFormatter associated to this Field. EnterpriseFields constructs and configures these EnterpriseFormatter for each Field listed in the EnterpriseObjects XML documents.

Parameters:

formatter - Enterpriseformatter

See Also:

EnterpriseFields, EnterpriseFormatter

isRequired

public boolean isRequired()

Convenience method that uses the EnterpriseFormatter associated to this field to determine if this Field is a required field.

Returns:

boolean true=field is required, false=field is not required.