Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKSearchEngineInfoFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKSearchEngineInfoFed
All Implemented Interfaces:
dkExtension, dkSearchEngineInfo, java.io.Serializable

public class DKSearchEngineInfoFed
extends java.lang.Object
implements dkSearchEngineInfo, java.io.Serializable

See Also:
Serialized Form

Constructor Summary
DKSearchEngineInfoFed()
          Constructs a new DKSearchEngineInfoFed object.
DKSearchEngineInfoFed(DKSearchEngineInfoFed aDKSearchEngineInfoFed)
          Copy constructor.
 
Method Summary
 void copyData(DKSearchEngineInfoFed aSourceSrchEngine)
          Copy data member values from the source DKSearchEngineInfoFed object.
 java.lang.String getIndexName()
          Gets the search index name of a search server
 java.lang.String getName()
          Gets the name of this extension object
 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 setName(java.lang.String extName)
          Sets the name of this extension object
 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 class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKSearchEngineInfoFed

public DKSearchEngineInfoFed()
Constructs a new DKSearchEngineInfoFed object.

DKSearchEngineInfoFed

public DKSearchEngineInfoFed(DKSearchEngineInfoFed aDKSearchEngineInfoFed)
Copy constructor.
Method Detail

getName

public java.lang.String getName()
                         throws java.lang.Exception
Gets the name of this extension object
Specified by:
getName in interface dkExtension
Returns:
name of this object

setName

public void setName(java.lang.String extName)
             throws java.lang.Exception
Sets the name of this extension object
Specified by:
setName in interface dkExtension
Parameters:
extName - name of this extension object

setSearchEngine

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

getSearchEngine

public java.lang.String getSearchEngine()
Gets the search engine name.
Specified by:
getSearchEngine in interface dkSearchEngineInfo
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.
Specified by:
setSearchIndex in interface dkSearchEngineInfo
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.
Specified by:
getSearchIndex in interface dkSearchEngineInfo
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)
Specified by:
setSearchInfo in interface dkSearchEngineInfo
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)
Specified by:
getSearchInfo in interface dkSearchEngineInfo
Returns:
a three character language code

setIndexName

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

getIndexName

public java.lang.String getIndexName()
Gets the search index name of a search server
Specified by:
getIndexName in interface dkSearchEngineInfo
Returns:
a search index name

setServerName

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

getServerName

public java.lang.String getServerName()
Gets the server name of the search manager.
Specified by:
getServerName in interface dkSearchEngineInfo
Returns:
a search server name

copyData

public void copyData(DKSearchEngineInfoFed aSourceSrchEngine)
Copy data member values from the source DKSearchEngineInfoFed object.
Parameters:
aSourceSrchEngine - a source DKSearchEngineInfoFed object

EIP Java APIs

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