|
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.sdk.common.DKSearchCriteria
Field Summary | |
static short |
DK_CRIT_DISPLAY_ONLY
|
static short |
DK_CRIT_QUERY_DISPLAY
|
static short |
DK_CRIT_QUERY_ONLY
|
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKSearchCriteria()
Creates a new instance with default values. |
|
DKSearchCriteria(java.lang.String entityName,
java.lang.String attrName)
Creates a new instance of search criteria with associated federated entity and attribute names. |
Method Summary | |
void |
addPredefinedValues(DKPredefinedValues pdefValues)
Adds the predefined value pairs of one native entity/attr for this search criteria. |
void |
addSearchEngine(dkSearchEngineInfo searchEngineInfo)
Adds search engine information object |
void |
addSearchEngine(java.lang.String serverName,
java.lang.String indexName)
Deprecated. Replace by addSearchEngine |
void |
clearSearchData()
Clears out search values and reset the search operator to undefined. |
java.lang.String |
getAssociatedEntityName()
Gets the associated entity name associated with this query This entity will support text and parametric query |
short |
getAttrId()
|
java.lang.String |
getAttrName()
Gets the associated federated attribute name of this search criteria |
short |
getCriteriaPosition()
Gets the order of this search criterion to be displayed in the search template. |
short |
getDataType()
Gets data type of the attribute of parametric criteria |
short |
getDefaultOperator()
Gets the default operator for this search criteria previously defined |
java.lang.String[] |
getDefaultValues()
Gets the default search value |
java.lang.String |
getDisplayName()
Gets the search criteria display name |
short |
getDisplayPosition()
Gets the column display order within the search results. |
short |
getDisplayWidth()
Gets the column display width within the search results. |
short |
getEntityId()
|
java.lang.String |
getEntityName()
Gets associated federated entity name of this search criteria |
short |
getId()
Gets search criteria id |
java.lang.String |
getName()
Gets search criteria name. |
short |
getOperator()
Gets the query operator |
dkCollection |
getPredefinedValues()
Gets the list of predefined search values for this criteria. |
dkSearchEngineInfo |
getSearchEngine(int index)
Gets search engine from the index position of search engine list (base 1) |
int |
getSearchEngineCount()
Gets the number of search engines |
short |
getType()
Gets the search criteria type. |
short[] |
getValidOperators()
Gets the list of valid query operators for this search criteria |
java.lang.String |
getValue()
Gets the text search value for this criteria |
java.lang.String[] |
getValues()
Gets the list of search values for this criteria |
boolean |
hasMultiValues()
Check if this search criteria has multi-values. |
boolean |
isDisplayable()
Checks whether this criterion is displayable in the result set |
boolean |
isQueryable()
Checks whether this criterion is queryable |
boolean |
isQuoteNeeded()
Returns true if the search criteria value need to be enclosed in single quotes when used to create a query term. |
boolean |
isSet()
Returns true if the search criteria value and operator are set. |
dkCollection |
listSearchEngines()
Gets a list of search criteria in this query |
void |
setAssociatedEntityName(java.lang.String assocEntityName)
Sets the associated entity name associated with this query This entity will support text and parametric query |
void |
setAttrId(short id)
|
void |
setAttrName(java.lang.String attrName)
Sets the associated federated attribute name of this search criteria |
void |
setCriteriaPosition(short order)
Sets the order of this search criterion to be displayed in the search template. |
void |
setDataType(short attrType)
Sets data type of the attribute of parametric criteria. |
void |
setDefaultOperator(short defOp)
Sets default operator for this search criteria |
void |
setDefaultValues(java.lang.String[] values)
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 criteria |
void |
setDisplayPosition(short order)
Sets the column display order within the search results. |
void |
setDisplayWidth(short width)
Sets the column display width within the search results. |
void |
setEntityId(short id)
|
void |
setEntityName(java.lang.String entityName)
Sets the associated federated entity name of this search criteria |
void |
setName(java.lang.String newName)
Sets the search criteria name |
void |
setOperator(short newOp)
Sets the search operator |
void |
setQueryable(boolean queryable)
Sets whether this criterion is queryable |
void |
setType(short aType)
Sets the search criteria type. |
void |
setValidOperators(short[] validOps)
Sets the valid operators for this search criteria |
void |
setValue(java.lang.String newVal)
Sets the text search value for this criteria |
void |
setValues(java.lang.String[] newValues)
Sets a new list of search values for this criteria |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final short DK_CRIT_DISPLAY_ONLY
public static final short DK_CRIT_QUERY_ONLY
public static final short DK_CRIT_QUERY_DISPLAY
Constructor Detail |
public DKSearchCriteria()
public DKSearchCriteria(java.lang.String entityName, java.lang.String attrName) throws DKException
entityName
- name of the associated federated entityattrName
- name of the associated federated attributeMethod Detail |
public java.lang.String getName()
public void setName(java.lang.String newName)
newName
- name of this search criteriapublic java.lang.String getDisplayName()
public void setDisplayName(java.lang.String dispName) throws DKUsageError
dispName
- search criteria display namepublic short getId()
public java.lang.String getEntityName()
public void setEntityName(java.lang.String entityName)
entityName
- associated entity namepublic java.lang.String getAttrName()
public void setAttrName(java.lang.String attrName)
attrName
- name of the associated federated attributepublic short getDefaultOperator()
public void setDefaultOperator(short defOp)
defOp
- default operator valuepublic short[] getValidOperators()
public void setValidOperators(short[] validOps) throws DKException
validOps
- an array of valid operatorspublic java.lang.String[] getDefaultValues()
public void setDefaultValues(java.lang.String[] values) throws DKException
value
- new default search valueif
- new value is null or invalidpublic dkCollection getPredefinedValues() throws DKException, java.lang.Exception
public void addPredefinedValues(DKPredefinedValues pdefValues) throws DKException
pdefValues
- a DKPredefinedValues that hold all value pairs for one native entity/attr.DKException
- if value pairs is empty.public short getOperator()
public void setOperator(short newOp)
newOp
- new search operator for this criteriapublic java.lang.String getValue()
public java.lang.String[] getValues()
public void setValue(java.lang.String newVal) throws DKException
newValue
- new search valuepublic void setValues(java.lang.String[] newValues) throws DKException
newValues
- an array of new search valuesDKException
- if newValues is null or invalidpublic boolean hasMultiValues()
public short getDisplayPosition()
public void setDisplayPosition(short order)
order
- display order, 0 basedpublic short getDisplayWidth()
public void setDisplayWidth(short width)
width
- display widthpublic short getCriteriaPosition()
public void setCriteriaPosition(short order)
order
- display order within search templatepublic void setDisplayable(boolean displayable)
displayable
- true if column for display, false otherwisepublic boolean isDisplayable()
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 setType(short aType)
aType
- a type indicates parametric, text or qbic searchpublic short getType()
public void addSearchEngine(dkSearchEngineInfo searchEngineInfo) throws DKException
searchEngineInfo
- a search engine info objectpublic void addSearchEngine(java.lang.String serverName, java.lang.String indexName) throws DKException
serverName
- a search server name ie. TMindexName
- a search index name ie. TMINDEXaddSearchEngine(com.ibm.mm.sdk.common.dkSearchEngineInfo)
public dkSearchEngineInfo getSearchEngine(int index) throws DKException
index
- a position index, the first one is 1public int getSearchEngineCount()
public dkCollection listSearchEngines() throws DKException, java.lang.Exception
public boolean isSet()
public short getDataType()
public void setDataType(short attrType)
attrType
- attribute data typepublic boolean isQuoteNeeded()
public void clearSearchData()
public java.lang.String getAssociatedEntityName()
public void setAssociatedEntityName(java.lang.String assocEntityName)
assocEntityName
- associated entity namepublic void setAttrId(short id)
public short getAttrId()
public void setEntityId(short id)
public short getEntityId()
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |