com.ibm.gre.samples.collectionhelpers
Class Column

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

public class Column
extends java.lang.Object

The Column Class encapsulate the standard attribute values for each Item element contained in the MetaData element from a Records Manager Query operation. These values describe each column that is returned for the query. See the documentation of the runQuery method in the QueryControllerEJB class for more information on the XML structure.


Constructor Summary
Column(org.w3c.dom.Node node)
          Constructor
 
Method Summary
 java.lang.String getFlPlnCmpntAttrDefCapt()
          The Caption that should be displayed for this column.
 java.lang.String getFlPlnCmpntAttrDefColNm()
          The unique name for the Component Attribute represented by the column.
 byte getFlPlnCmpntAttrDefDatTyp()
          The Records Manager data type for the column.
 int getFlPlnCmpntAttrDefNo()
          File Plan Component Attribute Definition Number
 int getFlPlnCmpntDefID()
          The Component Definition Id of the Component being reported on.
 int getPckLstID()
          The Id of a PickList that values for this column can be selected from.
 int getPercentWidth()
          Get the suggested percentage of the total width for all Columns that this column should take up.
 void setPercentWidth(int val)
          Set the suggested percentage of the total width for all Columns that this column should take up.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Column

public Column(org.w3c.dom.Node node)
       throws java.lang.Exception
Constructor

Parameters:
node - This is an XML Item element from the MetaData section of a query result string.
Throws:
java.lang.Exception
Method Detail

getPercentWidth

public int getPercentWidth()
Get the suggested percentage of the total width for all Columns that this column should take up.

Returns:
int

setPercentWidth

public void setPercentWidth(int val)
Set the suggested percentage of the total width for all Columns that this column should take up.

Parameters:
val - The percentage value.

getFlPlnCmpntAttrDefCapt

public java.lang.String getFlPlnCmpntAttrDefCapt()
The Caption that should be displayed for this column.

Returns:
String Caption

getFlPlnCmpntAttrDefColNm

public java.lang.String getFlPlnCmpntAttrDefColNm()
The unique name for the Component Attribute represented by the column.

Returns:
String File Plan Attribute Column Name

getFlPlnCmpntAttrDefDatTyp

public byte getFlPlnCmpntAttrDefDatTyp()
The Records Manager data type for the column.

Returns:
byte

getFlPlnCmpntAttrDefNo

public int getFlPlnCmpntAttrDefNo()
File Plan Component Attribute Definition Number

Returns:
int

getFlPlnCmpntDefID

public int getFlPlnCmpntDefID()
The Component Definition Id of the Component being reported on.

Returns:
int

getPckLstID

public int getPckLstID()
The Id of a PickList that values for this column can be selected from.

Returns:
int PickListId