|
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.DKForeignKeyDefICM
Use This class to represent a foregin key definition for a component type.
Constructor Summary | |
DKForeignKeyDefICM()
Default constructor construct a foreign key object. |
|
DKForeignKeyDefICM(dkDatastore ds)
Construct a foreign key object and initialize it with the datastore. |
|
DKForeignKeyDefICM(DKForeignKeyDefICM foreignKey)
A copy constructor for the foreign key object which make a copy of the specified foreign key. |
Method Summary | |
void |
addSrcAndTgtAttrName(java.lang.String srcAttrName,
java.lang.String tgtAttrName,
int columnSeq)
Adds a source attribute and the corresponding target attribute or column name to this foreign key. |
java.lang.String |
getConstraintName()
Gets the constraint name for this foreign key. |
dkDatastore |
getDatastore()
Gets the datastore where the item type, whose foreign keys this object represents is defined. |
short |
getDeleteRule()
Gets the delete rule for this foreign key constraint See setDeleteRule(short) in class for the detail information |
java.lang.String |
getSourceCompTypeName()
Gets source component type name for which this foreign key is defined |
java.lang.String |
getTargetCompTypeName()
Gets the target component type name which this foreign key references. |
java.lang.String |
getTargetSchemaName()
Gets the target schema name to which the target external table belong to. |
java.lang.String |
getTargetTableName()
Gets the target table name which this foreign key references. |
short |
getUpdateRule()
Gets the update rule for this foreign key constraint |
java.util.Vector |
listForeignKeyAttrInfo()
List source and target attributes and column sequence from this foreign key |
java.lang.String[] |
listSourceAttrNames()
Lists source attributes from this foreign key |
java.lang.String[] |
listTargetAttrNames()
Lists target attributes from this foreign key |
void |
removeSourceAttrName(java.lang.String srcAttrName)
Removes a source attribute from this foreign key |
void |
setConstraintName(java.lang.String constraintName)
Sets a constraint name for this foreign key. |
void |
setDatastore(dkDatastore ds)
Sets the datastore where the item type, whose foreign keys this object represents is defined. |
void |
setDeleteRule(short deleteRule)
Sets the delete rule for this foreign key constraint |
void |
setSourceCompTypeName(java.lang.String srcCompTypeName)
Sets the source component type name for which this foreign key if defined. |
void |
setTargetCompTypeName(java.lang.String tgtCompTypeName)
Sets the target component type name which this foreign key reference. |
void |
setTargetSchemaName(java.lang.String tgtSchemaName)
Sets the target schema name to which the target table belongs to. |
void |
setTargetTableName(java.lang.String tgtTableName)
Sets the target table name which this foreign key references. |
void |
setUpdateRule(short updateRule)
Sets the update rule for this foreign key constraint See #setDeleteRule(short) in this class for the detail information |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKForeignKeyDefICM()
public DKForeignKeyDefICM(dkDatastore ds)
public DKForeignKeyDefICM(DKForeignKeyDefICM foreignKey)
foreignKey
- - a foreign key objectMethod Detail |
public void setDatastore(dkDatastore ds)
ds
- - an ICM datastorepublic dkDatastore getDatastore()
public void setSourceCompTypeName(java.lang.String srcCompTypeName)
srcCompTypeName
- - source component type namepublic java.lang.String getSourceCompTypeName()
public void setTargetCompTypeName(java.lang.String tgtCompTypeName) throws DKException
tgtCompTypeName
- - target component type nameif
- this target component type already exists in this foreign key object.public java.lang.String getTargetCompTypeName()
public void setTargetTableName(java.lang.String tgtTableName) throws DKException
tgtTableName
- - target table name. SetTargetCompTypeName and setTargetTableName
are mutually exclusive. The foreign key can either reference a component type which
is internal to the ICM datastore or a external database table.if
- this target table name already exists in this foreign key object.public java.lang.String getTargetTableName()
public void setTargetSchemaName(java.lang.String tgtSchemaName)
tgtShemaName
- - target schema namepublic java.lang.String getTargetSchemaName()
public void setConstraintName(java.lang.String constraintName)
constraintName
- - constraint namepublic java.lang.String getConstraintName()
public void setDeleteRule(short deleteRule)
the
- delete rule for this foreign key constraint.
The possible values are
public short getDeleteRule()
public void setUpdateRule(short updateRule)
updateRule
- - update rule for this foreign key constraintpublic short getUpdateRule()
setDeleteRule(short)
public void addSrcAndTgtAttrName(java.lang.String srcAttrName, java.lang.String tgtAttrName, int columnSeq) throws DKAlreadyExistException, DKException, java.lang.Exception
srcAttrName
- - the source attribute name in the format of attrGroupName.attrNametgtAttrName
- - the target attribute name in the format of attrGroupName.attrNamecolumnSeq
- - Numeric position of the column in the key.
The sequence must start with 0 and be incremented by one for each column of the key.if
- the source attribute already exists in this foreign key object.public void removeSourceAttrName(java.lang.String srcAttrName) throws DKNotExistException, DKException
attrName
- name of the attribute need to be removedpublic java.lang.String[] listSourceAttrNames() throws DKException
public java.lang.String[] listTargetAttrNames() throws DKException
public java.util.Vector listForeignKeyAttrInfo()
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |