|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.DKComponentTypeIndexDefICM
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 |
public DKComponentTypeIndexDefICM()
public DKComponentTypeIndexDefICM(dkDatastore ds)
ds
- - datastore object as an instance of DKDatastoreICM
.Method Detail |
public void add() throws DKException, java.lang.Exception
DKException
- - if an error is encountered.public void del() throws DKException, java.lang.Exception
DKException
- when error occurs.public java.lang.String getName()
public void setName(java.lang.String indexName)
public void setIndexSchema(java.lang.String indexSchema)
indexSchema
- - value to set the indexSchema for this component type index to.public DKComponentTypeDefICM getComponentType()
DKComponentTypeDefICM
.public void setComponentType(DKComponentTypeDefICM compType)
component
- - type - component type definition object with which this component type index is associated.
The parameter is an object of type DKComponentTypeDefICM
.public int getComponentTypeId()
public void setComponentTypeId(int compTypeID)
compTypeId
- - identifier of the component type to be associated with
this component type index.public void addAttr(dkAttrDef attrObj) throws DKAlreadyExistException, DKException, java.lang.Exception
attrObj
- - an attribute definition as an instance of DKAttrDefICM
.DKAlreadyExistException
- if this attribute already exists as part
of the definition of this component type index.public boolean isUnique()
public void setUnique(boolean unique)
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 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |