Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKComponentTypeIndexDefICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKComponentTypeIndexDefICM
All Implemented Interfaces:
DKConstant, DKConstantICM, DKMessageId, DKMessageIdICM

public class DKComponentTypeIndexDefICM
extends java.lang.Object
implements DKConstantICM, DKMessageIdICM

This class defines methods to access database index information on root or child component


Fields inherited from interface com.ibm.mm.sdk.common.DKConstantICM
    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.DKMessageIdICM
    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
DKComponentTypeIndexDefICM()
          Default constructor for the component type index class.
DKComponentTypeIndexDefICM(dkDatastore ds)
          Constructs an instance of the index class definition for the given ICM datastore.
 
Method Summary
 void add()
          Adds the definition of this component type index to the persistent store.
 void addAttr(dkAttrDef attrObj)
          Adds a new attribute to the in-memory representation of this component type index.
 void del()
          Deletes the definition of is component type index from the persistent store.
 DKComponentTypeDefICM getComponentType()
          Retrieves the component type definition object with which the component type index is associated.
 int getComponentTypeId()
          Retrieves the identifier for the component type associated with this component type index.
 java.lang.String getName()
          Retrieves the name of the component type index.
 boolean isUnique()
          Returns true if the database index underlying this component type index unique; false otherwise.
 void setComponentType(DKComponentTypeDefICM compType)
          Sets the component type with which this component type index is associated.
 void setComponentTypeId(int compTypeID)
          Sets the identifer for the component type to be associated with this component type index.
 void setIndexSchema(java.lang.String indexSchema)
          Sets the index schema value for this component type index.
 void setName(java.lang.String indexName)
          Sets the name of this component type index name to the specified value.
 void setUnique(boolean unique)
          Sets the uniqueness property for the database index underlying this component type index.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKComponentTypeIndexDefICM

public DKComponentTypeIndexDefICM()
Default constructor for the component type index class. Constructs the definition of the index class for a component type definition.

DKComponentTypeIndexDefICM

public DKComponentTypeIndexDefICM(dkDatastore ds)
Constructs an instance of the index class definition for the given ICM datastore.
Parameters:
ds - - datastore object as an instance of DKDatastoreICM.
Method Detail

add

public void add()
         throws DKException,
                java.lang.Exception
Adds the definition of this component type index to the persistent store.
Throws:
DKException - - if an error is encountered.

del

public void del()
         throws DKException,
                java.lang.Exception
Deletes the definition of is component type index from the persistent store.
Throws:
DKException - when error occurs.

getName

public java.lang.String getName()
Retrieves the name of the component type index.
Returns:
name of this component type index.

setName

public void setName(java.lang.String indexName)
Sets the name of this component type index name to the specified value.
Returns:
indexName - value to set the name of the index to.

setIndexSchema

public void setIndexSchema(java.lang.String indexSchema)
Sets the index schema value for this component type index.
Parameters:
indexSchema - - value to set the indexSchema for this component type index to.

getComponentType

public DKComponentTypeDefICM getComponentType()
Retrieves the component type definition object with which the component type index is associated.
Returns:
component type object associated with this component type index as an instance of DKComponentTypeDefICM.

setComponentType

public void setComponentType(DKComponentTypeDefICM compType)
Sets the component type with which this component type index is associated.
Parameters:
component - - type - component type definition object with which this component type index is associated. The parameter is an object of type DKComponentTypeDefICM.

getComponentTypeId

public int getComponentTypeId()
Retrieves the identifier for the component type associated with this component type index.
Returns:
identifier for the component type associated with this component type index.

setComponentTypeId

public void setComponentTypeId(int compTypeID)
Sets the identifer for the component type to be associated with this component type index.
Parameters:
compTypeId - - identifier of the component type to be associated with this component type index.

addAttr

public void addAttr(dkAttrDef attrObj)
             throws DKAlreadyExistException,
                    DKException,
                    java.lang.Exception
Adds a new attribute to the in-memory representation of this component type index. This new attribute will henceforth become a part of the index and be used to refine searches on the associated component etc once the changes to the component index are added to the persistent store.
Parameters:
attrObj - - an attribute definition as an instance of DKAttrDefICM.
Throws:
DKAlreadyExistException - if this attribute already exists as part of the definition of this component type index.

isUnique

public boolean isUnique()
Returns true if the database index underlying this component type index unique; false otherwise.
Returns:
boolean value that indicates whether the database index underlying this component type index is unique or not. By default the database index is not unique (false return from this method call).

setUnique

public void setUnique(boolean unique)
Sets the uniqueness property for the database index underlying this component type index.
Parameters:
unique - - if this value is true, the database index is henceforth set to be unique; if this value is false, the database index is marked as not being unique.

EIP Java APIs

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