|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.beans.CMBSTCriterion
This is a helper class for CMBSearchTemplate bean. It represents information for a particular search criterion.
CMBSearchTemplate
, Serialized FormField Summary | |
static int |
CMB_CRIT_TYPE_PARAMETRIC
Search criterion type: parametric |
static int |
CMB_CRIT_TYPE_TEXT
Search criterion type: text |
Constructor Summary | |
CMBSTCriterion()
Construct a new default search criterion object |
Method Summary | |
void |
clearSearchData()
Clears current search value and operator for this criterion. |
java.lang.String |
getAttrName()
Gets the associated attribute name |
short |
getAttrType()
Gets the associated attribute type |
short |
getCriteriaPosition()
Gets the order of this search criterion to be displayed in the search template. |
short |
getDefaultOperator()
Gets the default search operator. |
java.lang.String[] |
getDefaultValue()
Gets the default search value |
java.lang.String |
getDefaultValue(int index)
Gets the default search value |
java.lang.String |
getDisplayName()
Gets the search criterion display name |
short |
getDisplayPosition()
Gets the column display order within the search results. |
short |
getDisplayWidth()
Gets the display column initial width |
java.lang.String |
getEntityName()
Gets the associated entity name |
java.lang.String |
getName()
Gets the name of this search criterion |
short |
getOperator()
Gets the search operator for this criterion |
java.lang.String[] |
getPredefinedValues()
Gets the list of predefined values |
java.lang.String |
getPredefinedValues(int index)
Gets the predefined value for a given index |
java.lang.String |
getTemplateName()
Gets the search template name |
int |
getType()
Gets search criterion type |
short[] |
getValidOperators()
Gets the list of valid search operators |
java.lang.String |
getValue()
Gets the search value for this search criterion |
java.lang.String[] |
getValues()
Gets the list of search values for this search criterion |
java.lang.String |
getValues(int index)
Gets the search value for a given index |
boolean |
isDisplayable()
Checks whether this criterion is displayable in the result set |
boolean |
isQueryable()
Checks whether this criterion is queryable |
void |
setAttrName(java.lang.String attrName)
Sets the associated attribute name |
void |
setAttrType(short attrType)
Sets the associated attribute type |
void |
setCriteriaPosition(short order)
Sets the order of this search criterion to be displayed in the search template. |
void |
setDefaultOperator(short op)
Sets the default search operator |
void |
setDefaultValue(java.lang.String[] value)
Sets the default search value for this criteria |
void |
setDisplayable(boolean displayable)
Sets whether this criterion is displayable in the result set |
void |
setDisplayName(java.lang.String dispName)
Sets display name in result list for this search criterion |
void |
setDisplayPosition(short order)
Sets the column display order within the search results. |
void |
setDisplayWidth(short width)
Sets the display column initial width |
void |
setName(java.lang.String name)
Sets the name of this search criterion |
void |
setOperator(short op)
Set the search operator for this criterion |
void |
setQueryable(boolean queryable)
Sets whether this criterion is queryable |
void |
setTemplateName(java.lang.String stName)
Sets the search template name for this search criterion |
void |
setType(int type)
Sets search criterion type |
void |
setValidOperators(short[] ops)
Sets the valid set of search operators for this criterion |
void |
setValue(java.lang.String value)
Sets the search value for this search criterion |
void |
setValues(java.lang.String[] values)
Sets the search values for this criterion |
java.lang.String |
toString()
Return a meaningful string representation of the object |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int CMB_CRIT_TYPE_PARAMETRIC
public static final int CMB_CRIT_TYPE_TEXT
Constructor Detail |
public CMBSTCriterion()
Method Detail |
public java.lang.String getName()
public void setName(java.lang.String name)
name
- search criterion namepublic java.lang.String getAttrName()
public void setAttrName(java.lang.String attrName)
attrName
- attribute namepublic short getAttrType()
public void setAttrType(short attrType)
attrName
- attribute typepublic java.lang.String getEntityName()
public int getType()
public void setType(int type)
type
- either CMB_CRIT_TYPE_PARAMETRIC or CMB_CRIT_TYPE_TEXTpublic java.lang.String getDisplayName()
public void setDisplayName(java.lang.String dispName)
dispName
- search criterion display namepublic short getDisplayWidth()
public void setDisplayWidth(short width)
display
- widthpublic java.lang.String getTemplateName()
public void setTemplateName(java.lang.String stName)
stName
- search template namepublic java.lang.String[] getDefaultValue()
public java.lang.String getDefaultValue(int index) throws java.lang.ArrayIndexOutOfBoundsException
public void setDefaultValue(java.lang.String[] value)
value
- new default search valueif
- new value is null or invalidpublic java.lang.String[] getPredefinedValues()
public java.lang.String getPredefinedValues(int index)
index
- predefined value indexjava.lang.ArrayIndexOutOfBoundsException
- if the index is out of boundpublic short getDefaultOperator()
public void setDefaultOperator(short op)
op
- default search operatorpublic short[] getValidOperators()
public void setValidOperators(short[] ops)
ops
- an array of valid search operatorspublic short getOperator()
public void setOperator(short op)
op
- search operatorpublic java.lang.String getValue()
search
- valuepublic void setValue(java.lang.String value) throws java.lang.IllegalArgumentException
value
- new search valuejava.lang.IllegalArgumentException
- if value is null.public java.lang.String[] getValues()
public java.lang.String getValues(int index)
index
- search value indexjava.lang.ArrayIndexOutOfBoundsException
- if the index is out of boundpublic void setValues(java.lang.String[] values) throws java.lang.IllegalArgumentException
values
- search valuesjava.lang.IllegalArgumentException
- if values is null or empty array.public void setQueryable(boolean queryable)
queryable
- true if this criterion will be participate in
the formulation of the query, false otherwisepublic boolean isQueryable()
public void setDisplayable(boolean displayable)
displayable
- true if column for display, false otherwisepublic boolean isDisplayable()
public short getCriteriaPosition()
public void setCriteriaPosition(short order)
order
- display order within search templatepublic short getDisplayPosition()
public void setDisplayPosition(short order)
order
- display order, 0 basedpublic void clearSearchData()
public java.lang.String toString()
toString
in class java.lang.Object
|
EIP JavaBeans | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |