com.ibm.gre.samples.collectionhelpers
Class Line

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

public class Line
extends java.lang.Object

Represents a single line that will be displayed in a QueryForm A Line also represents parts of the Query element in a Records Manager XML Query string. Each line is either a FieldExpression or an InterFieldOperator or one of a limited number of optional fields.


Constructor Summary
Line(org.w3c.dom.Element fieldElement, int nFlPlnCmpntAttrDefDatTyp, java.lang.String key, java.lang.String caption, int pickListId, int lineType, int controlType, byte tab)
          Constructor for a Line object
 
Method Summary
 java.lang.String getCaption()
          The caption to display for this line.
 int getControlType()
          The type of UI control that will be associated with the line.
 org.w3c.dom.Element getFieldElement()
          The XML element that is associated with this line.
 int getFlPlnCmpntAttrDefDatTyp()
          The data type represented on this line
 java.lang.String getKey()
          The name of the XML eleement represented by this line.
 int getLineType()
          The type of line that will be displayed.
 int getPickListId()
          The Picklist ID associated with the line.
 byte getTab()
           
 void setFieldElement(java.lang.String val)
          Sets the value for the XML element that is associated with this line.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Line

public Line(org.w3c.dom.Element fieldElement,
            int nFlPlnCmpntAttrDefDatTyp,
            java.lang.String key,
            java.lang.String caption,
            int pickListId,
            int lineType,
            int controlType,
            byte tab)
Constructor for a Line object

Parameters:
fieldElement - The FieldValue element of a FieldExpression, or null if not used.
nFlPlnCmpntAttrDefDatTyp - The data type of the FieldValue, or 0 if not relevant.
key - The name of the XML element this line represents.
caption - The Caption to display.
pickListId - The ID of a picklist associated with the FieldValue.
lineType - The type of line to display. See LineType.
controlType - The type of control that is used on this line.
tab - The number of tab characters appended to the line.
Method Detail

getCaption

public java.lang.String getCaption()
The caption to display for this line.

Returns:
String

getControlType

public int getControlType()
The type of UI control that will be associated with the line.

Returns:
int See com.ibm.gre.engine.util.ProfileControlType

getFieldElement

public org.w3c.dom.Element getFieldElement()
The XML element that is associated with this line. In some cases this will be a FieldValue, Scope or optional field.

Returns:
Element The XML element that is associated with this Line.

setFieldElement

public void setFieldElement(java.lang.String val)
Sets the value for the XML element that is associated with this line.

Parameters:
val - The value to set.

getKey

public java.lang.String getKey()
The name of the XML eleement represented by this line.

Returns:
String

getLineType

public int getLineType()
The type of line that will be displayed. For example LineType.SCOPE

Returns:
int See LineType.

getFlPlnCmpntAttrDefDatTyp

public int getFlPlnCmpntAttrDefDatTyp()
The data type represented on this line

Returns:
int See com.ibm.gre.engine.util.AttributeDataTypes

getPickListId

public int getPickListId()
The Picklist ID associated with the line.

Returns:
int

getTab

public byte getTab()
Returns:
byte