com.ibm.ccd.ui.taglib.dataobjects
Class ResultMetaData

java.lang.Object
  extended by com.ibm.ccd.ui.taglib.dataobjects.ResultMetaData
All Implemented Interfaces:
ISelectListTag

public class ResultMetaData
extends java.lang.Object
implements ISelectListTag

Represents the Metdadata associated with the Results This class provides the information about result attributes
viz. name, type, visibility, sortable This information represents the column data in the result set

Version:
1.0

Constructor Summary
ResultMetaData()
          Constructs an empty ResultMetaData
ResultMetaData(java.lang.String name, int type)
          Constructs ResultMetaData with the specified name and sortable flag
ResultMetaData(java.lang.String name, int type, boolean sortable, boolean displayable)
          Constructs ResultMetaData with the specified name and sortable flag
 
Method Summary
 boolean getCurrentlySorted()
          Gets the currentlySorted
 java.lang.String getDisplayName()
           
 int getListBoxIndex()
           
 java.lang.String getName()
          Returns the name associated with the current element
 int getType()
          Returns the type of the result element
 boolean isDisplayable()
          Specifies visibility of this element
 boolean isMandatory()
           
 boolean isSelected()
           
 boolean isSortable()
          Specifies sortability of the result set based on this element
 void setCurrentlySorted(boolean currentlySorted)
          Sets the currentlySorted
 void setDisplayable(boolean aDisplayable)
          Specifies visibility of this element
 void setDisplayName(java.lang.String string)
           
 void setListBoxIndex(int i)
           
 void setMandatory(boolean b)
           
 void setName(java.lang.String aName)
          Sets the name associated with the current element
 void setSortable(boolean sortable)
          Specifies sortability of the result set based on this element
 void setType(int aType)
          Sets the type of the result element
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResultMetaData

public ResultMetaData()
Constructs an empty ResultMetaData


ResultMetaData

public ResultMetaData(java.lang.String name,
                      int type)
Constructs ResultMetaData with the specified name and sortable flag

Parameters:
name - , Name of the ELement
type - of the elemement

ResultMetaData

public ResultMetaData(java.lang.String name,
                      int type,
                      boolean sortable,
                      boolean displayable)
Constructs ResultMetaData with the specified name and sortable flag

Parameters:
name - , Name of the ELement
type - type of the elemement
sortable -
displayable -
Method Detail

getName

public java.lang.String getName()
Returns the name associated with the current element

Specified by:
getName in interface ISelectListTag
Returns:
String, the name of the result set element

getType

public int getType()
Returns the type of the result element

Returns:
int, Element Type
See Also:
ISearchElementTypesEnum

setType

public void setType(int aType)
Sets the type of the result element

Parameters:
aType - , Element Type

isDisplayable

public boolean isDisplayable()
Specifies visibility of this element

Returns:
true, If the element can be displayed
false, If the element can not be displayed

isSortable

public boolean isSortable()
Specifies sortability of the result set based on this element

Returns:
true, If the result set can be sorted based on this
false, If the result set cann't be sorted based on this

setDisplayable

public void setDisplayable(boolean aDisplayable)
Specifies visibility of this element

Parameters:
aDisplayable - true, If the element can be displayed
false, If the element can not be displayed

setName

public void setName(java.lang.String aName)
Sets the name associated with the current element

Parameters:
aName - , the name of the result set element

setSortable

public void setSortable(boolean sortable)
Specifies sortability of the result set based on this element

Parameters:
sortable - true, If the result set can be sorted based on this
false, If the result set cann't be sorted based on this

getCurrentlySorted

public boolean getCurrentlySorted()
Gets the currentlySorted

Returns:
Returns a boolean

setCurrentlySorted

public void setCurrentlySorted(boolean currentlySorted)
Sets the currentlySorted

Parameters:
currentlySorted - The currentlySorted to set

isSelected

public boolean isSelected()
Specified by:
isSelected in interface ISelectListTag

getDisplayName

public java.lang.String getDisplayName()
Specified by:
getDisplayName in interface ISelectListTag

getListBoxIndex

public int getListBoxIndex()
Specified by:
getListBoxIndex in interface ISelectListTag

setListBoxIndex

public void setListBoxIndex(int i)
Parameters:
i -

isMandatory

public boolean isMandatory()
Returns:
boolean

setMandatory

public void setMandatory(boolean b)
Parameters:
b -

setDisplayName

public void setDisplayName(java.lang.String string)
Parameters:
string -