Index

DXSearchIndexDefTS

Purpose:

This class defines methods to access entity information for Text Search.

Methods:

datastoreName
BSTR datastoreName();

Get datastore name.

datastoreType
BSTR datastoreType();

Get datastore type.

getName
BSTR getName();

Gets an entity name.

setName
setName(LPCTSTR name);

Sets an entity name.

getType
short getType();

Gets the entity type.

setType
setType(short type);

Sets the entity type.

getId
short getId();

Gets entity ID.

setId
setId(short id);

Sets entity ID.

getDescription
BSTR getDescription();

Gets the description.

setDescription
setDescription(LPCTSTR name);

Sets the description.

isSearchable
BOOL isSearchable();

Returns TRUE if searchable.

getIndexType
long getIndexType();

Gets index type.

setIndexType
setIndexType(long indexType);

Sets index type.

getIndexFeature
long getIndexFeature();

Gets index feature.

setIndexFeature
setIndexFeature(long indexFeature);

Sets index feature.

getIndexProperty
long getIndexProperty();

Gets index property.

setIndexProperty
setIndexProperty(long indexProperty);

Sets index property.

getIndexCCSID
long getIndexCCSID();

Gets index CCSID.

setIndexCCSID
setIndexCCSID(long indexCCSID);

Sets index CCSID.

getLibraryId
BSTR getLibraryId();

Gets index library ID.

setLibraryId
setLibraryId(LPCTSTR libId);

Sets index library ID.

getLibraryClientServices
BSTR getLibraryClientServices();

Gets library client services.

setLibraryClientServices
setLibraryClientServices(LPCTSTR libClientSrv);

Sets library client services.

getLibraryServerServices
BSTR getLibraryServerServices();

Gets library server services.

setLibraryServerServices
setLibraryServerServices(LPCTSTR libServerSrv);

Sets library server services.

getIndexDataArea
BSTR getIndexDataArea();

Gets index data area.

setIndexDataArea
setIndexDataArea(LPCTSTR indexDataArea);

Sets index data area.

getIndexWorkArea
BSTR getIndexWorkArea();

Gets index work area.

setIndexWorkArea
setIndexWorkArea(LPCTSTR indexWorkArea);

Sets index work area.

getIndexTitleCCSID
long getIndexTitleCCSID();

Gets index title CCSID.

setIndexTitleCCSID
setIndexTitleCCSID(long indexTitleCCSID);

Sets index title CCSID.

getIndexTitle
BSTR getIndexTitle();

Gets index title.

setIndexTitle
setIndexTitle(LPCTSTR indexTitle);

Sets index title.

getIndexDescriptionCCSID
long getIndexDescriptionCCSID();

Gets index description CCSID.

setIndexDescriptionCCSID
setIndexDescriptionCCSID(long indexDescCCSID);

Sets index description CCSID.

getIndexDescription
BSTR getIndexDescription();

Gets index description

setIndexDescription
setIndexDescription(LPCTSTR indexDesc);

Sets index description

numberOfDocModels
long numberOfDocModels();

Gets the number of document models.

getDocModel
LPDISPATCH getDocModel(long docModelIndex);

Gets the document model. The docModelIndex is from 1 to the number of documentation models. If the document model is not found a null is returned.

add
add();

Adds this entity definition to the persistent datastore.

del
del();

Deletes this entity from the persistent datastore. The in-memory copy is not changed.

getDatastore
LPDISPATCH getDatastore();

Gets the datastore. The returned LPDISPATCH pointer contains a DXDatastoreTS object.

setDatastore
setDatastore(LPDISPATCH ds);

Sets the datastore. The input parameter LPDISPATCH pointer contains a DXDatastoreTS object.

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