com.instantbank.component.job.util
Class Field

java.lang.Object
  |
  +--com.instantbank.component.job.util.Field
All Implemented Interfaces:
java.io.Serializable

public class Field
extends java.lang.Object
implements java.io.Serializable

In memory representation of a system field of the current company (corresponding to table com.instantbank.common.utilcomponents.DatabaseNames.LETT_FIELD)

Author:
InstantBank (Consuelo Franky)
See Also:
Serialized Form

Field Summary
private  java.lang.String dataType
          data type of field: LetterTemplateGlobals.FIELD_NUMERIC, FIELD_STRING, FIELD_DATE
private  java.lang.String displayName
          display name corresponding to field (for the current company)
private  java.lang.String fieldColumn
          column name corresponding to field
private  long fieldId
          unique code of field
private  long menuId
          code of associated value menu (optional: it can be LetterTemplateGlobals.UNDEF)
private  java.lang.String offsetType
          offset type of field (relevant for date fields): LetterTemplateGlobals.NO_OFFSET, WORKABLE_DAYS_OFFSET, CHRONO_DAYS_OFFSET
private  java.lang.String rootType
          root type for joins: LetterTemplateGlobals.ROOT_AGREEMENTS
private  java.lang.String tableAlias
          table alias associated to field
 
Constructor Summary
Field(long fieldId, java.lang.String tableAlias, java.lang.String rootType, java.lang.String fieldColumn, java.lang.String dataType, long menuId, java.lang.String offsetType, java.lang.String displayName)
          Constructor for the Field object
 
Method Summary
 java.lang.String getDataType()
          Gets the dataType attribute of the Field object
 java.lang.String getDisplayName()
          Gets the displayName attribute of the Field object
 java.lang.String getFieldColumn()
          Gets the fieldColumn attribute of the Field object
 long getFieldId()
          Gets the fieldId attribute of the Field object
 long getMenuId()
          Gets the menuId attribute of the Field object
 java.lang.String getOffsetType()
          Gets the offsetType attribute of the Field object
 java.lang.String getRootType()
          Gets the rootType attribute of the Field object
 java.lang.String getTableAlias()
          Gets the tableAlias attribute of the Field object
 java.lang.String toString()
          Representation textual of the Field object
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

fieldId

private long fieldId
unique code of field

tableAlias

private java.lang.String tableAlias
table alias associated to field

rootType

private java.lang.String rootType
root type for joins: LetterTemplateGlobals.ROOT_AGREEMENTS

fieldColumn

private java.lang.String fieldColumn
column name corresponding to field

dataType

private java.lang.String dataType
data type of field: LetterTemplateGlobals.FIELD_NUMERIC, FIELD_STRING, FIELD_DATE

menuId

private long menuId
code of associated value menu (optional: it can be LetterTemplateGlobals.UNDEF)

offsetType

private java.lang.String offsetType
offset type of field (relevant for date fields): LetterTemplateGlobals.NO_OFFSET, WORKABLE_DAYS_OFFSET, CHRONO_DAYS_OFFSET

displayName

private java.lang.String displayName
display name corresponding to field (for the current company)
Constructor Detail

Field

public Field(long fieldId,
             java.lang.String tableAlias,
             java.lang.String rootType,
             java.lang.String fieldColumn,
             java.lang.String dataType,
             long menuId,
             java.lang.String offsetType,
             java.lang.String displayName)
Constructor for the Field object
Parameters:
fieldId - unique code of field
tableAlias - table alias associated to field
rootType - root type for joins
fieldColumn - column name corresponding to field
dataType - data type of field
menuId - code of associated value menu
offsetType - offset type of field
displayName - display name of field (for current company)
Method Detail

getFieldId

public long getFieldId()
Gets the fieldId attribute of the Field object
Returns:
The fieldId value

getTableAlias

public java.lang.String getTableAlias()
Gets the tableAlias attribute of the Field object
Returns:
The tableAlias value

getRootType

public java.lang.String getRootType()
Gets the rootType attribute of the Field object
Returns:
The rootType value

getFieldColumn

public java.lang.String getFieldColumn()
Gets the fieldColumn attribute of the Field object
Returns:
The fieldColumn value

getDataType

public java.lang.String getDataType()
Gets the dataType attribute of the Field object
Returns:
The dataType value

getMenuId

public long getMenuId()
Gets the menuId attribute of the Field object
Returns:
The menuId value

getOffsetType

public java.lang.String getOffsetType()
Gets the offsetType attribute of the Field object
Returns:
The offsetType value

getDisplayName

public java.lang.String getDisplayName()
Gets the displayName attribute of the Field object
Returns:
The displayName value

toString

public java.lang.String toString()
Representation textual of the Field object
Overrides:
toString in class java.lang.Object
Returns:
text of the Field object