Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkSearchEngineInfo

All Superinterfaces:
dkExtension
All Known Implementing Classes:
DKSearchEngineInfoFed, DKSearchEngineInfoDL

public interface dkSearchEngineInfo
extends dkExtension

This is an abstract class for all search engine information objects.


Method Summary
 java.lang.String getIndexName()
          Gets the search index name of a search server
 java.lang.String getSearchEngine()
          Gets the search engine name.
 java.lang.String getSearchIndex()
          Gets search index, the search index should be a null-terminated string(ASCII).
 java.lang.String getSearchInfo()
          Gets the search information value; a three character code, valid in the NLS Language Table that identifies the language.(ie.
 java.lang.String getServerName()
          Gets the server name of the search manager.
 void setIndexName(java.lang.String indexName)
          Sets the search index name of a search server
 void setSearchEngine(java.lang.String aSearchEngineName)
          Sets the search engine name, the search engine should be a null-terminated string(ASCII).
 void setSearchIndex(java.lang.String aSearchIndex)
          Sets search index, the search index should be a null-terminated string(ASCII).
 void setSearchInfo(java.lang.String aLangCode)
          Sets the search information value; a three character code, valid in the NLS Language Table that identifies the language.(ie.
 void setServerName(java.lang.String serverName)
          Sets the server name of the search manager.
 
Methods inherited from interface com.ibm.mm.sdk.common.dkExtension
getName, setName
 

Method Detail

setSearchEngine

public void setSearchEngine(java.lang.String aSearchEngineName)
Sets the search engine name, the search engine should be a null-terminated string(ASCII).
Parameters:
aSearchEngineName - a search engine name

getSearchEngine

public java.lang.String getSearchEngine()
Gets the search engine name.
Returns:
a search engine name

setSearchIndex

public void setSearchIndex(java.lang.String aSearchIndex)
Sets search index, the search index should be a null-terminated string(ASCII). ie. "SearchService-IndexName" for TextMiner and "DataBase-Catalog-SearchServer" for QBIC.
Parameters:
aSearchIndex - a search index

getSearchIndex

public java.lang.String getSearchIndex()
Gets search index, the search index should be a null-terminated string(ASCII). ie. "SearchService-IndexName" for TextMiner and "DataBase-Catalog-SearchServer" for QBIC.
Returns:
a search index

setSearchInfo

public void setSearchInfo(java.lang.String aLangCode)
Sets the search information value; a three character code, valid in the NLS Language Table that identifies the language.(ie. ENU is US English, JAP is Japanese)
Parameters:
aLangCode - a three character language code

getSearchInfo

public java.lang.String getSearchInfo()
Gets the search information value; a three character code, valid in the NLS Language Table that identifies the language.(ie. ENU is US English, JAP is Japanese)
Returns:
a three character language code

setIndexName

public void setIndexName(java.lang.String indexName)
Sets the search index name of a search server
Returns:
a search index name

getIndexName

public java.lang.String getIndexName()
Gets the search index name of a search server
Returns:
a search index name

setServerName

public void setServerName(java.lang.String serverName)
Sets the server name of the search manager.
Parameters:
serverName - a search engine server name

getServerName

public java.lang.String getServerName()
Gets the server name of the search manager.
Returns:
a search server name

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.