com.ibm.gre.samples.collectionhelpers
Class IRMField

java.lang.Object
  |
  +--com.ibm.gre.samples.collectionhelpers.IRMField

public class IRMField
extends java.lang.Object

The IRMField class encapsulates a Field element from a Records manager Complex Fields Collection returned by one of the TemplateControllerEJB methods. The class contains methods for getting attribute values, getting and setting Field values and other utility functions.


Constructor Summary
IRMField(org.w3c.dom.Element field)
          Constructor
 
Method Summary
 int getAttrCntrlMsk()
          Attribute Control Mask
 java.lang.String getCaption()
          Caption
 int getControlType()
          Returns the constant value specifying the type of control to display.
 int getDatTypMaxLngth()
          Data Type Maximum Length.
 org.w3c.dom.Element getFieldForAdd()
          Returns the XML Field element with all attributes removed except the FlPlnCmpntAttrDefColNm attribute.
 boolean getFldLvlAccess()
          Field Level Access
 java.lang.String getFlPlnCmpntAttrDefColNm()
          File Plan Component Attribute Column Name
 int getFlPlnCmpntAttrDefDatTyp()
          File Plan Component Attribute Definition Data Type
 int getFlPlnCmpntDefID()
          File Plan Component Definition ID
 boolean getIsActive()
          Gets if the field should be used.
 boolean getIsPersonalPickList()
          Returns true if this field contains a personal Pick List.
 boolean getIsVisible()
          Sets if the field should be visible on a form.
 boolean getMandatory()
          Mandatory flag.
 boolean getMultiValuedFlg()
          Multi valued flag.
 int getPckLstID()
          Pick List ID.
 boolean getReadOnly()
          Read Only flag.
 java.lang.String getValue()
          Gets the value for the field.
 void setIsActive(boolean val)
          Sets if the field should be used.
 void setIsVisible(boolean val)
          Gets if the field should be visible on a form.
 void setValue(java.lang.String val)
          Sets the value for the field.
 java.lang.String ToString()
          Returns the FlPlnCmpntAttrDefColNm for this field.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IRMField

public IRMField(org.w3c.dom.Element field)
Constructor

Parameters:
field - An XML Field element from a Records Manager Fields Collection
Method Detail

getControlType

public int getControlType()
                   throws java.lang.Exception
Returns the constant value specifying the type of control to display.

Returns:
int
Throws:
java.lang.Exception

ToString

public java.lang.String ToString()
                          throws java.lang.Exception
Returns the FlPlnCmpntAttrDefColNm for this field.

Returns:
File Plan Component Attribute Column Name
Throws:
java.lang.Exception

getFlPlnCmpntAttrDefColNm

public java.lang.String getFlPlnCmpntAttrDefColNm()
                                           throws java.lang.Exception
File Plan Component Attribute Column Name

Returns:
String
Throws:
java.lang.Exception

getFlPlnCmpntDefID

public int getFlPlnCmpntDefID()
                       throws java.lang.Exception
File Plan Component Definition ID

Returns:
int
Throws:
java.lang.Exception

getFlPlnCmpntAttrDefDatTyp

public int getFlPlnCmpntAttrDefDatTyp()
                               throws java.lang.Exception
File Plan Component Attribute Definition Data Type

Returns:
int
Throws:
java.lang.Exception

getAttrCntrlMsk

public int getAttrCntrlMsk()
                    throws java.lang.Exception
Attribute Control Mask

Returns:
int
Throws:
java.lang.Exception

getCaption

public java.lang.String getCaption()
                            throws java.lang.Exception
Caption

Returns:
String
Throws:
java.lang.Exception

getFldLvlAccess

public boolean getFldLvlAccess()
                        throws java.lang.Exception
Field Level Access

Returns:
boolean
Throws:
java.lang.Exception

getMandatory

public boolean getMandatory()
                     throws java.lang.Exception
Mandatory flag.

Returns:
boolean
Throws:
java.lang.Exception

getMultiValuedFlg

public boolean getMultiValuedFlg()
                          throws java.lang.Exception
Multi valued flag.

Returns:
boolean
Throws:
java.lang.Exception

getReadOnly

public boolean getReadOnly()
                    throws java.lang.Exception
Read Only flag.

Returns:
boolean
Throws:
java.lang.Exception

getIsPersonalPickList

public boolean getIsPersonalPickList()
                              throws java.lang.Exception
Returns true if this field contains a personal Pick List.

Returns:
boolean
Throws:
java.lang.Exception

getDatTypMaxLngth

public int getDatTypMaxLngth()
                      throws java.lang.Exception
Data Type Maximum Length.

Returns:
int
Throws:
java.lang.Exception

getPckLstID

public int getPckLstID()
                throws java.lang.Exception
Pick List ID.

Returns:
int
Throws:
java.lang.Exception

getFieldForAdd

public org.w3c.dom.Element getFieldForAdd()
Returns the XML Field element with all attributes removed except the FlPlnCmpntAttrDefColNm attribute.

Returns:
The XML Field element.

getValue

public java.lang.String getValue()
                          throws java.lang.Exception
Gets the value for the field.

Returns:
String
Throws:
java.lang.Exception

setValue

public void setValue(java.lang.String val)
              throws java.lang.Exception
Sets the value for the field.

Parameters:
val -
Throws:
java.lang.Exception

getIsVisible

public boolean getIsVisible()
Sets if the field should be visible on a form.

Returns:
boolean

setIsVisible

public void setIsVisible(boolean val)
Gets if the field should be visible on a form.

Parameters:
val -

getIsActive

public boolean getIsActive()
Gets if the field should be used.

Returns:
boolean

setIsActive

public void setIsActive(boolean val)
Sets if the field should be used.

Parameters:
val -