Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKSearchIndexDefTS

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractEntityDef
        |
        +--com.ibm.mm.sdk.common.DKSearchIndexDefTS
All Implemented Interfaces:
DKConstant, DKConstantDL, dkEntityDef, DKMessageId, DKMessageIdDL, java.io.Serializable

public class DKSearchIndexDefTS
extends dkAbstractEntityDef
implements DKConstantDL, DKMessageIdDL, java.io.Serializable

This class defines methods to access entity information for TS.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDL
    For details, see the class or interface
 
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.DKMessageIdDL
DK_DL_MSG_INVNBR_TEXTMAPPING, DK_DL_MSG_MSGID_NOT_FOUND
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKSearchIndexDefTS()
          Constructs an search index def for TS
DKSearchIndexDefTS(dkDatastore ds)
          Constructs an search index def for TS
 
Method Summary
 void add()
          Adds this entity definition to the persistent store, i.e.
 void addDocModel(DKDocModelTS docModel)
          Adds a document model.
 void del()
          Deletes this entity from the persistent store, e.g.
 DKDocModelTS getDocModel(int docModelIndex)
          Gets the document model.
 int getIndexCCSID()
          Gets index CCSID
 java.lang.String getIndexDataArea()
          Gets index data area
 java.lang.String getIndexDescription()
          Gets index description
 int getIndexDescriptionCCSID()
          Gets index description CCSID
 int getIndexFeature()
          Gets index feature
 int getIndexProperty()
          Gets index property
 java.lang.String getIndexTitle()
          Gets index title
 int getIndexTitleCCSID()
          Gets index title CCSID
 int getIndexType()
          Gets index type
 java.lang.String getIndexWorkArea()
          Gets index work area
 java.lang.String getLibraryClientServices()
          Gets library client services
 java.lang.String getLibraryId()
          Gets index library id
 java.lang.String getLibraryServerServices()
          Gets library server services
 int numberOfDocModels()
          Gets the number of document models.
 void setIndexCCSID(int indexCCSID)
          Sets index CCSID
 void setIndexDataArea(java.lang.String indexDataArea)
          Sets index data area
 void setIndexDescription(java.lang.String indexDesc)
          Sets index description
 void setIndexDescriptionCCSID(int indexDescCCSID)
          Sets index description CCSID
 void setIndexFeature(int indexFeature)
          Sets index feature
 void setIndexProperty(int indexProperty)
          Sets index property
 void setIndexTitle(java.lang.String indexTitle)
          Sets index title
 void setIndexTitleCCSID(int indexTitleCCSID)
          Sets index title CCSID
 void setIndexType(int indexType)
          Sets index type
 void setIndexWorkArea(java.lang.String indexWorkArea)
          Sets index work area
 void setLibraryClientServices(java.lang.String libClientSrv)
          Sets library client services
 void setLibraryId(java.lang.String libId)
          Sets index library id
 void setLibraryServerServices(java.lang.String libServerSrv)
          Sets library server services
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractEntityDef
add, add, addAttr, addSubEntity, clearCache, createAttr, createSubEntity, datastoreName, datastoreType, del, del, deleteAttr, deleteSubEntity, getAttr, getDatastore, getDescription, getName, getParentEntityName, getSubEntity, getType, hasSubEntities, isSearchable, isTextSearchable, listAttrNames, listAttrs, listSubEntities, listSubEntityNames, removeAttr, removeSubEntity, retrieveAttr, retrieveSubEntity, setDatastore, setDescription, setName, setParentEntityName, setTextSearchable, setType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKSearchIndexDefTS

public DKSearchIndexDefTS()
Constructs an search index def for TS

DKSearchIndexDefTS

public DKSearchIndexDefTS(dkDatastore ds)
Constructs an search index def for TS
Parameters:
ds - datastore
Method Detail

add

public void add()
         throws DKException,
                java.lang.Exception
Adds this entity definition to the persistent store, i.e. make this entity persistent.
Overrides:
add in class dkAbstractEntityDef
Throws:
DKException - when the subclass does not implement this method

del

public void del()
         throws DKException,
                java.lang.Exception
Deletes this entity from the persistent store, e.g. drop table. The in-memory copy is not changed.
Overrides:
del in class dkAbstractEntityDef
Throws:
DKException - when the subclass does not implement this method

getIndexType

public int getIndexType()
Gets index type
Returns:
index type

setIndexType

public void setIndexType(int indexType)
Sets index type
Parameters:
indexType - index type

getIndexFeature

public int getIndexFeature()
Gets index feature
Returns:
index feature

setIndexFeature

public void setIndexFeature(int indexFeature)
Sets index feature
Parameters:
indexFeature - index feature

getIndexProperty

public int getIndexProperty()
Gets index property
Returns:
index property

setIndexProperty

public void setIndexProperty(int indexProperty)
Sets index property
Parameters:
indexProperty - index property

getIndexCCSID

public int getIndexCCSID()
Gets index CCSID
Returns:
index CCSID

setIndexCCSID

public void setIndexCCSID(int indexCCSID)
Sets index CCSID
Parameters:
indexCCSID - index CCSID

getLibraryId

public java.lang.String getLibraryId()
Gets index library id
Returns:
index library id

setLibraryId

public void setLibraryId(java.lang.String libId)
Sets index library id
Parameters:
libId - index library id

getLibraryClientServices

public java.lang.String getLibraryClientServices()
Gets library client services
Returns:
library client services

setLibraryClientServices

public void setLibraryClientServices(java.lang.String libClientSrv)
Sets library client services
Parameters:
libClientSrv - library client services

getLibraryServerServices

public java.lang.String getLibraryServerServices()
Gets library server services
Returns:
library service services

setLibraryServerServices

public void setLibraryServerServices(java.lang.String libServerSrv)
Sets library server services
Parameters:
libServerSrv - library server services

getIndexDataArea

public java.lang.String getIndexDataArea()
Gets index data area
Returns:
index data area

setIndexDataArea

public void setIndexDataArea(java.lang.String indexDataArea)
Sets index data area
Parameters:
indexDataArea - index data area

getIndexWorkArea

public java.lang.String getIndexWorkArea()
Gets index work area
Returns:
index work area

setIndexWorkArea

public void setIndexWorkArea(java.lang.String indexWorkArea)
Sets index work area
Parameters:
indexWorkArea - index work area

getIndexTitleCCSID

public int getIndexTitleCCSID()
Gets index title CCSID
Returns:
index title CCSID

setIndexTitleCCSID

public void setIndexTitleCCSID(int indexTitleCCSID)
Sets index title CCSID
Parameters:
indexTitleCCSID - index title CCSID

getIndexTitle

public java.lang.String getIndexTitle()
Gets index title
Returns:
index title

setIndexTitle

public void setIndexTitle(java.lang.String indexTitle)
Sets index title
Parameters:
indexTitle - index title

getIndexDescriptionCCSID

public int getIndexDescriptionCCSID()
Gets index description CCSID
Returns:
index description CCSID

setIndexDescriptionCCSID

public void setIndexDescriptionCCSID(int indexDescCCSID)
Sets index description CCSID
Parameters:
indexDescCCSID - index description CCSID

getIndexDescription

public java.lang.String getIndexDescription()
Gets index description
Returns:
index description

setIndexDescription

public void setIndexDescription(java.lang.String indexDesc)
Sets index description
Parameters:
indexDesc - index description

numberOfDocModels

public int numberOfDocModels()
Gets the number of document models.
Returns:
number of document models

getDocModel

public DKDocModelTS getDocModel(int docModelIndex)
                         throws DKException
Gets the document model. The docModelIndex is from 1 to the number of doc models. If the document model is not found a null is returned.
Parameters:
docModelIndex - the document model index
Returns:
a document model section

addDocModel

public void addDocModel(DKDocModelTS docModel)
Adds a document model.
Parameters:
docModel - a document model

EIP Java APIs

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